GET /admin/api/{api_version}/shopify_payments/disputes.json

Retrieve all disputes ordered by initiated_at date and time (ISO 8601 format), with the most recent being first. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

Servers

Path parameters

Name Type Required Description
api_version String Yes

Request headers

Name Type Required Description
x-shopify-access-token String No

Query parameters

Name Type Required Description
initiated_at String No

Return only disputes with the specified initiated_at date (ISO 8601 format).

last_id String No

Return only disputes before the specified ID.

since_id String No

Return only disputes after the specified ID.

status String No

Return only disputes with the specified status.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.