Skip to main content

List Refunds

GET 

/api/purple-dot/:instance/refunds

Lists refunds issued through Purple Dot from SKU.io for a connection, newest first. Failed refunds (for example an automatic refund on return receipt that Purple Dot refused) keep their error and Purple Dot's response code.

Required scope: inventory:read

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

Query parameters:

  • filter[status] (optional): succeeded or failed.
  • page, per_page (optional): pagination, default 10 per page (max 100).

Authentication: Requires a Bearer token. Requires the integrations.show permission.

Request​

Responses​

OK

Response Headers
    Content-Type