/pre-orders
Last updated
Last updated
Note for customers using our platform integration with combined cart: this data does not include in-stock purchases that went through Purple Dot's checkout.
Request:
limit
(number) - The number of pre-orders to retrieve. By default, it's set to 10 but can be set up to 200
created_at_min
(ISO8610 timestamp) - List pre-orders created since the given time
updated_at_min
(ISO8610 timestamp) - List pre-orders updated since the given time
references
(string) - Comma separated list of (URL-encoded) Purple Dot order references
skus
(string) - Comma separated list of product variant SKUs
all_line_items
(string) - List pre-orders where every line item is any of these comma separated states. Currently supported are cancelled
and exported
some_line_item
(string) - List pre-orders where at least 1 line item is any of these comma separated states. Currently supported are cancelled
and exported
. Cannot be used in conjunction with all_line_items
starting_after
(UUID) - Paginate pre-orders after the given pre-order ID
Headers:
Link
- An IETF compliant header with links to previous and next page of results for the pre-order query.
Body:
orders
- An array containing pre-orders
id
- ID used to identify the pre-order inside Purple Dot
reference
- The Purple Dot order reference, the same as shared with the shoppers
currency
- The presentment currency of the order
created_at
- ISO8610 timestamp of when the pre-order was placed
cancelled_at
- ISO8610 timestamp of when the whole order was canceled (null if not canceled)
cancel_reason
- The reason for the cancelation
customer
email
- The customer's email address
external_id
- The Shopify ID of this customer, if we know it
line_items
- Array of line items
id
- The Purple Dot ID of the line item
price
- The unit cost of the product variant in this line item, before taxes/discounts etc
total
- The total cost of this line item, after tax/discounts etc are considered
taxable
- Whether the product variant in this line item is taxable
tax_lines
- The taxes applied to the line item
price
rate
title
total_discount
- The total amount of discounts applied to the line item
quantity
- The quantity of the line item
product_id
- The Shopify ID of the line item's product
variant_id
- The Shopify ID of the line item's product variant
sku
- The SKU code of the product variant in this line item
name
- The name of the product variant in this line item
earliest_ship_date
- ISO8610 timestamp of the earliest date this line item is expected to ship
latest_ship_date
- ISO8610 timestamp of the latest date this line item is expected to ship
cancelled
- If this line item has been canceled
cancelled_at
- ISO8610 timestamp of when the whole order was canceled (null if not canceled)
shipping_address
first_name
last_name
address1
address2
city
postal_code
province_code
- The ISO3166 code of the second level administrative subdivision
country
- The English name of the country
country_code
- The ISO3166 code of the country
phone
shipping_lines
- An array of shipping rates
id
- The Purple Dot ID of the shipping line
price
- The unit cost of this shipping line, before taxes/discounts etc
total
- The total cost of this shipping line, after tax/discounts etc are considered
title
- The user-facing name of the shipping rate
code
- The shipping rate carrier code
tax_lines
- The taxes applied to the shipping rate
price
rate
title
line_items
- The line items this shipping rate applies to
line_item_id
- The Purple Dot ID of the line item
subtotal_price
- The total of the line items before taxes and shipping
total_discounts
- The total discounts applied to the pre-order
total_tax
- The total tax on the pre-order
tax_included
- Whether the tax is included in listed prices or not
tax_lines
- All the taxes applied to the pre-order
price
rate
title
total_price
- The pre-order total
total_refunded
- The total of all refunds issued from this pre-order
exported_orders
- Any orders that were exported to Shopify from this pre-order
id
- The Shopify ID of the order that was exported
order_number
- The Shopify order number
created_at
- ISO8610 timestamp of when this external order was created
line_items
- The pre-order line items that were exported
id
- The Shopify ID of the line item
line_item_id
- The Purple Dot ID of the line item
starting_after
- The ID of the last pre-order in the list which can then be used in the next request
has_more
- Indicates whether there are more pre-orders available to page through
Examples: