Skip to main content

Match Shopify Collective Debit

POST 

/api/shopify/:integrationInstance/collective-debits/:transaction/match

Pair a Shopify Collective debit with the drop-ship purchase order it pays, typically one listed as ambiguous or unmatched. SKU.io bills the purchase order for the debit and marks the bill paid from Shopify Payments; for a reversal it records a vendor credit against the purchase order's bill instead. The payout the transaction belongs to is re-posted so the debit is no longer counted as a separate fee.

Required scope: integrations:write

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

Body:

  • purchase_order_id (required, integer): the purchase order to pay. When the debit's Shopify order is in SKU.io, the purchase order must be a drop-ship purchase order of that order.

Matching a debit that is already matched returns it unchanged.

Errors: 422 when the purchase order does not exist, is not a drop-ship purchase order of the debit's order, or the transaction is not a Collective debit. 404 when the transaction belongs to another Shopify store.

Path: transaction is the SKU.io balance transaction id (the id field of List Shopify Collective Debits).

Authentication: Requires Bearer token (integrations:write).

Request​

Responses​

OK

Response Headers
    Content-Type