This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-22 22:09 UTC.
Signed in, you can send this request to your own sandbox merchant from the console
and read the answer.
Sign in to try it.
Example request
Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.
The request body is a . See the Request body section below for its fields.
Parameters
Name
In
Type
Description
productrequired
path
string
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
suppressNullsrequired
query
boolean
If true, omit properties with null values.
Values:Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Request body
application/json, required
Field
Type
Description
This request body has no documented fields.
Responses
200OK
Body:
Each item has these fields.
Field
Type
Description
This response has no body.
404Not Found
Body:
Each item has these fields.
Field
Type
Description
This response has no body.
503Service Unavailable
Body:
Each item has these fields.
Field
Type
Description
This response has no body.
defaultThe request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The error reference lists the values `error.code` can take.