/fulfillment-proxy/orders

GET /fulfillment-proxy/orders

List All Proxy Orders

This feature is under active development and may change. For more information, contact [e-mail].

Request:

• limit (number) - The number of pre-orders to retrieve. By default, it's set to 50 but can be set up to 250

• created_at_min (ISO8610 timestamp) - List pre-orders created since the given time

• starting_after (UUID) - Paginate pre-orders after the given pre-order ID

Body:

• orders - An array containing pre-orders

  • id - ID used to identify the pre-order inside Purple Dot

  • created_at - ISO8610 timestamp of when the pre-order was placed

  • shopify_parent_order_id - ID of parent Shopify ORder

  • shopify_fulfillment_order_id- ID of related Shopify Fulfillment Order

  • reference - The Purple Dot order reference, the same as shared with the shoppers

  • currency - The presentment currency of the order

  • 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

    • shopify_line_item_id - The Shopify 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

    • 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

  • 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

• 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 orders available to page through