Skip to main content

Get Shopify Partner Order Summary

GET 

/api/shopify/:integrationInstance/partner-orders/summary

Count the store's partner orders by cost status, with the purchase order cost in each, plus the number of Shopify Collective debits in each match status.

Required scope: integrations:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

statuses always lists all eight cost statuses (po_recorded, shipped, not_billed, billed, paid, debit_matched, variance, cost_missing), each with count and po_total; total is the sum of the counts. collective_debits counts the store's Collective debits by match status (unmatched, matched, ambiguous, no_order, no_purchase_order, ignored); only statuses that occur are listed, and it is not limited by the date range.

cost_status (the first that applies):

  • cost_missing: a purchase order line has no cost.
  • variance: its Collective debit was matched but differs from the purchase order cost plus shipping.
  • debit_matched: its Collective debit was matched and billed.
  • paid: billed and the bill is paid.
  • billed: billed, not paid.
  • not_billed: shipped more than 7 days ago and not billed.
  • shipped: shipped recently, not billed yet.
  • po_recorded: recorded, not shipped yet.

Query: date_from and date_to (optional, account timezone dates; m/d/Y or Y-m-d) limit the purchase orders by date. date_to must be on or after date_from (422 otherwise).

Authentication: Requires Bearer token (integrations:read).

Request​

Responses​

OK

Response Headers
    Content-Type