Skip to main content

Import Sales Credits

POST 

/api/sales-credits/import

Execute the import — upsert sales credits from validated data (typically the output of the Validate Import endpoint).

Required scope: orders:write

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

Authentication: Requires Bearer token (scope.rw:orders).

Upsert behavior:

  • Rows with no matched existing credit are CREATED (customers are auto-created when needed).
  • Rows matching an existing editable credit are UPDATED.
  • Rows with action=blocked are rejected (paid / allocated / closed / Shopify-origin credits cannot be updated via import).

continue_on_error (default false): when true, each credit is imported in its own transaction and failures are collected into 'skipped'. When false, the entire import runs in one transaction.

Returns 201 when any credit was created, otherwise 200.

Request

Responses

Created

Response Headers
    Content-Type