/pre-orders
List all pre-orders.
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) - Optional. The number of pre-orders to retrieve. Set to 10 by default but can be set up to 200created_at_min(ISO8610 timestamp) - Optional. List pre-orders created since the given timeupdated_at_min(ISO8610 timestamp) - Optional. List pre-orders updated since the given timereferences(string) - Optional. Comma separated list of (URL-encoded) Purple Dot order referencesskus(string) - Optional. Comma separated list of product variant SKUsall_line_items(string) - Optional. List pre-orders where every line item is any of these comma separated states. Currently supported arecancelledandexportedsome_line_item(string) - Optional. List pre-orders where at least 1 line item is any of these comma separated states. Currently supported arecancelledandexported. Cannot be used in conjunction withall_line_itemsstarting_after(UUID) - Optional. Paginate pre-orders after the given pre-order ID
Headers:
Link- An IETF RFC 8288 compliant header with links to previous and next page of results for the pre-order query.
Body:
orders- An array containing pre-ordersid- ID used to identify the pre-order inside Purple Dotreference- The Purple Dot order reference, the same as shared with the shopperscurrency- The presentment currency of the ordercreated_at- ISO8610 timestamp of when the pre-order was placedcancelled_at- ISO8610 timestamp of when the whole order was canceled (null if not canceled)cancel_reason- The reason for the cancelationcustomeremail- The customer's email addressexternal_id- The Shopify ID of this customer, if we know it
line_items- Array of line itemsid- The Purple Dot ID of the line itemname- The name of the product variant in this line itemsku- The SKU code of the product variant in this line itemproduct_id- The Shopify ID of the line item's productvariant_id- The Shopify ID of the line item's product variantwaitlist_id- The Purple Dot ID of the Waitlist this line item sold from. Could be null if the line item was in-stock at the time of sale but it was held back to ship with other line items that were on pre-orderprice- The total cost of this line item, before taxes/discounts etctotal- The total cost of this line item, after tax/discounts etcquantity- The quantity of the line itemunit_price-pricedivided byquantityunit_total-totaldivided byquantitytaxable- Whether the product variant in this line item is taxabletax_lines- The taxes applied to the line itempriceratetitleinclusive
total_discount- The total amount of discounts applied to the line itemearliest_ship_date- ISO8610 timestamp of the earliest date this line item is expected to shiplatest_ship_date- ISO8610 timestamp of the latest date this line item is expected to shipcancelled- If this line item has been canceledcancelled_at- ISO8610 timestamp of when the whole order was canceled (null if not canceled)
shipping_addressfirst_namelast_nameaddress1address2citypostal_codeprovince_code- The ISO3166 code of the second level administrative subdivisioncountry- The English name of the countrycountry_code- The ISO3166 code of the countryphone
shipping_lines- An array of shipping ratesid- The Purple Dot ID of the shipping lineprice- The unit cost of this shipping line, before taxes/discounts etctotal- The total cost of this shipping line, after tax/discounts etc are consideredtitle- The user-facing name of the shipping ratecode- The shipping rate carrier codetax_lines- The taxes applied to the shipping ratepriceratetitle
line_items- The line items this shipping rate applies toline_item_id- The Purple Dot ID of the line item
subtotal_price- The total of the line items before taxes and shippingtotal_discounts- The total discounts applied to the pre-ordertotal_tax- The total tax on the pre-ordertax_included- Whether the tax is included in listed prices or nottax_lines- All the taxes applied to the pre-orderpriceratetitle
total_price- The pre-order totaltotal_refunded- The total of all refunds issued from this pre-orderexported_orders- Any orders that were exported to Shopify from this pre-orderid- The Shopify ID of the order that was exportedorder_number- The Shopify order numbercreated_at- ISO8610 timestamp of when this external order was createdline_items- The pre-order line items that were exportedid- The Shopify ID of the line itemline_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 requesthas_more- Indicates whether there are more pre-orders available to page through
Examples:
curl --request GET \
--url 'https://www.purpledotprice.com/admin/api/v1/pre-orders?created_at_min=2023-08-17T00:00:00.000Z&references=%23PD325376&all_line_items=cancelled&skus=TEST1&limit=1' \
--header 'X-Purple-Dot-Access-Token: <access_token>'{
"meta": {
"result": "success"
},
"data": {
"orders": [
{
"id": "58da51c9-9b48-48c6-beb5-46bd34834960",
"reference": "#PD2850312",
"cancel_reason": null,
"cancelled_at": null,
"created_at": "2024-11-14T16:18:25.635Z",
"currency": "USD",
"email": "[email protected]",
"customer": {
"email": "[email protected]",
"external_id": "7287702192181"
},
"line_items": [
{
"id": "55bedf52-ccf0-431a-a75b-2e999e93a5da",
"total": 26.01,
"price": 39.99,
"product_id": "6914583167029",
"quantity": 1,
"sku": "PS4-GRVN",
"variant_id": "41125120573493",
"name": "Test Product 1",
"earliest_ship_date": "2025-03-01T05:00:00.000Z",
"latest_ship_date": "2025-03-31T04:00:00.000Z",
"taxable": true,
"tax_lines": [
{
"price": 2.12,
"rate": 0.08875,
"title": "SALES_TAX",
"inclusive": false
}
],
"total_discount": 16.1,
"cancelled_at": null,
"cancelled": false,
},
{
"id": "e474a996-d861-41e0-8137-7fc2074dd6a5",
"total": 22.75,
"price": 34.99,
"product_id": "7740980330549",
"quantity": 1,
"sku": "P5LR123",
"variant_id": "44057813581877",
"name": "Test Product 2",
"earliest_ship_date": null,
"latest_ship_date": null,
"taxable": true,
"tax_lines": [
{
"price": 1.85,
"rate": 0.08875,
"title": "SALES_TAX",
"inclusive": false
}
],
"total_discount": 14.09,
"cancelled_at": "2024-11-14T16:20:39.796Z",
"cancelled": true
}
],
"shipping_address": {
"address1": "10 Test Road",
"address2": "",
"city": "New York",
"country": "United States",
"country_code": "US",
"first_name": "Test",
"last_name": "Testington",
"phone": "+19172756975",
"province_code": "NY",
"postal_code": "10463"
},
"shipping_lines": [
{
"id": "6dfe69ca-ba0e-5af5-864c-693982161631",
"code": "usps_1058",
"total": 3.9000000000000004,
"price": 5.98,
"title": "Calculated Shipping Rate",
"tax_lines": [
{
"price": 0.32,
"rate": 0.08875,
"title": "SALES_TAX",
"inclusive": false
}
],
"line_items": [
{
"line_item_id": "e474a996-d861-41e0-8137-7fc2074dd6a5"
}
]
},
{
"id": "ca1dc988-7078-5f95-b1a8-3c0722d41ba4",
"code": "usps_1058",
"total": 3.88,
"price": 5.98,
"title": "Calculated Shipping Rate",
"tax_lines": [
{
"price": 0.31,
"rate": 0.08875,
"title": "SALES_TAX",
"inclusive": false
}
],
"discount_allocations": [
{
"amount": 2.41,
"discount_application_index": 0
}
],
"line_items": [
{
"line_item_id": "55bedf52-ccf0-431a-a75b-2e999e93a5da"
}
]
}
],
"subtotal_price": 39.99,
"tax_lines": [
{
"price": 2.12,
"rate": 0.08875,
"title": "SALES_TAX"
}
],
"tax_included": false,
"total_discounts": 20.91,
"total_price": 21.2,
"total_tax": 2.12,
"total_refunded": 56.54,
"exported_orders": [
{
"id": "5616927408181",
"created_at": "2024-11-14T16:22:59.432Z",
"order_number": "#3114029",
"line_items": [
{
"id": "13278614585397",
"line_item_id": "55bedf52-ccf0-431a-a75b-2e999e93a5da"
}
]
}
]
}
],
"starting_after": "58da51c9-9b48-48c6-beb5-46bd34834960",
"has_more": false,
"previous_cursor": "935bad68-2726-4ad1-b299-a330650a2bbb"
}
}Last updated