/pre-orders
As well as including your store's public API key as an api_key
query parameter in all requests, this endpoint requires a few other parameters:
How to generate the token
token
Purple Dot expects a SHA-256 hash of the email
and the timestamp
in the following format:
<email>:<timestamp>
You can generate the token in liquid as shown below:
Get all pre-orders for a given shopper email address.
Request:
limit
(number) - The number of pre-orders to retrieve. By default, it's set to 10 but can be set up to 100starting_after
(UUID) - Paginate pre-orders after the given pre-order ID
Response:
orders
- An array containing all the pre-ordersid
- The Purple Dot ID of the pre-orderreference
- The Purple Dot reference number of the pre-ordercreated_at
- The timestamp at which the pre-order was placed (formatted in the ISO 8601 format)total_amount
- The pre-order totalcurrency
- The presentment currency of the pre-orderline_items
- Array of line itemsid
- The Purple Dot ID of the line itemestimated_ship_dates
- The estimated ship dates of the line itemproduct_id
- The Shopify ID of the line item's productvariant_id
- The Shopify ID of the line item's product variantorder_id
- The Shopify order ID in (this will benull
if the preorder/line-item is not exported to Shopify)cancelled
- Whether the line item is cancelled
shipping_address
first_name
last_name
address1
address2
city
postal_code
province_code
- The ISO3166 code of the second level administrative subdivisioncountry_code
- The ISO3166 code of the countryphone
has_more
- Indicates whether there are more pre-orders available to page throughstarting_after
- The ID of the last pre-order in the list which can then be used in the next request
Examples:
Last updated