Skip to main content
GET
Node.js

Authorizations

Authorization
string
header
required

A secret API key, made under Developers in the dashboard: Authorization: Bearer shoply_sk_...

Path Parameters

storeId
string
required

The store's ID. A key reaches the store it was made in: GET /key answers which.

Query Parameters

q
string

Part of the buyer's email, the order's ID or the provider's ID for the dispute.

show
enum<string>
default:all

Only these: open is the two that have not ended.

Available options:
all,
open,
needs_response,
under_review,
won,
lost,
accepted,
closed
provider
string

Only disputes with this payment method, by its ID.

Example:

"stripe"

Response

The file itself, not a JSON envelope.

The response is of type file.