Skip to main content

List Shopify Collective Debits

GET 

/api/shopify/:integrationInstance/collective-debits

List the store's Shopify Collective debits, newest first. A Collective debit is a Shopify Payments balance transaction in which Shopify pays a Collective supplier for an order it shipped (a reversal returns that money). SKU.io matches each debit to the record-only drop-ship purchase order of the same order; the matched purchase order is billed and the bill is marked paid from Shopify Payments, so the supplier cost is counted once.

Required scope: integrations:read

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

Transaction types: shopify_collective_debit, shopify_collective_debit_reversal, merchant_to_merchant_debit, merchant_to_merchant_debit_reversal, shopify_source_debit, shopify_source_debit_reversal. is_reversal is true for the *_reversal types; a matched reversal produces a vendor credit instead of a bill.

match.status:

  • unmatched: not processed yet.
  • matched: paired with a purchase order; purchase_invoice (or vendor_credit for a reversal) is set. variance_amount is the difference between the debit and the purchase order cost plus shipping.
  • ambiguous: more than one purchase order could be paid by it; candidate_purchase_order_ids lists them. Use Match Shopify Collective Debit to choose.
  • no_order: the Shopify order is not in SKU.io.
  • no_purchase_order: the order has no drop-ship purchase order to pay.
  • ignored: deliberately not matched.

amount is signed as Shopify reports it (debits are negative). transaction_date is a date in the account timezone. payout is null until the transaction is part of a Shopify payout.

Pagination: 10 per page by default; standard paginated response.

Authentication: Requires Bearer token (integrations:read).

Request​

Responses​

OK

Response Headers
    Content-Type