Node.js

import Shoply from "@shoplygg/node";

const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

const page = await shoply.disputes.list();

// Or every row of every page:
for await (const row of shoply.disputes.list()) {
  console.log(row);
}

<?php

require 'vendor/autoload.php';

$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

$page = $shoply->disputes->list();

// Or every row of every page:
foreach ($shoply->disputes->list() as $row) {
    print_r($row);
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shoply.gg/v1/stores/{storeId}/disputes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.shoply.gg/v1/stores/{storeId}/disputes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": null,
  "code": null,
  "data": [
    {
      "id": "ae36fc25-3cea-4d17-acaa-4bdb43d84a0e",
      "orderId": "71ed606f-3119-4f9f-b7f7-ecd25740e15b",
      "email": "mila@example.com",
      "provider": "stripe",
      "providerName": "Stripe",
      "externalId": "dp_1QdZ8x2eZvKYlo2C",
      "reason": "fraudulent",
      "reasonText": "Says they did not make the payment",
      "stage": "chargeback",
      "providerStatus": "needs_response",
      "status": "needs_response",
      "amount": 49,
      "currency": "USD",
      "dueAt": "2026-10-27T16:20:19Z",
      "answer": {
        "state": "",
        "at": null,
        "by": "",
        "note": ""
      },
      "answeredFrom": "provider",
      "answerPlace": "your Stripe Dashboard",
      "accessTaken": false,
      "dateCreated": "2026-10-22T16:20:19Z",
      "dateClosed": null
    },
    {
      "id": "0f8aa05a-52c5-4fc5-8180-36aec2177869",
      "orderId": "cc9beefe-9e86-42db-8ef0-354c1ab48b0a",
      "email": "jonas@example.com",
      "provider": "paypal",
      "providerName": "PayPal",
      "externalId": "PP-D-27803",
      "reason": "merchandise_or_service_not_received",
      "reasonText": "Says it never arrived",
      "stage": "claim",
      "providerStatus": "waiting_for_seller_response",
      "status": "needs_response",
      "amount": 10,
      "currency": "USD",
      "dueAt": "2026-10-31T16:20:19Z",
      "answer": {
        "state": "",
        "at": null,
        "by": "",
        "note": ""
      },
      "answeredFrom": "provider",
      "answerPlace": "PayPal's Resolution Center",
      "accessTaken": false,
      "dateCreated": "2026-10-22T16:20:19Z",
      "dateClosed": null
    }
  ],
  "pages": 1,
  "total": 2,
  "meta": {
    "figures": {
      "needs": 2,
      "dueSoon": 0,
      "atRisk": 59,
      "won": 0,
      "lost": 0,
      "disputed": 2,
      "orders": 6,
      "currency": "USD",
      "days": 90
    },
    "providers": [
      {
        "id": "paypal",
        "name": "PayPal"
      },
      {
        "id": "stripe",
        "name": "Stripe"
      }
    ]
  }
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

Disputes

List disputes

The disputes buyers opened on the store’s payments, as their payment providers reported them: the ones that need an answer first, soonest deadline first, then the rest newest first. status is how it reads on the dashboard: needs_response, under_review, won, lost, accepted or closed (ended with no chargeback). providerStatus is the provider’s own last word, stage is inquiry, chargeback, claim (a PayPal case), pre_arbitration or arbitration, and dueAt when the provider stops taking an answer, where it says. answeredFrom is where it is answered: here (through this API: Stripe’s, Revolut’s, Adyen’s, and PayPal’s where PayPal is connected with API keys), provider (in the provider’s own dashboard, named in answerPlace) or none. meta.figures is the dashboard’s four: how many need an answer and how many are due within three days, the money in the open ones in the store’s currency, how many ended won and lost in the last 90 days, and the orders disputed beside those that took money in that time.

Needs the disputes.read permission (Read Disputes).

GET

stores

{storeId}

disputes

Node.js

import Shoply from "@shoplygg/node";

const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

const page = await shoply.disputes.list();

// Or every row of every page:
for await (const row of shoply.disputes.list()) {
  console.log(row);
}

<?php

require 'vendor/autoload.php';

$shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

$page = $shoply->disputes->list();

// Or every row of every page:
foreach ($shoply->disputes->list() as $row) {
    print_r($row);
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.shoply.gg/v1/stores/{storeId}/disputes"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.shoply.gg/v1/stores/{storeId}/disputes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": null,
  "code": null,
  "data": [
    {
      "id": "ae36fc25-3cea-4d17-acaa-4bdb43d84a0e",
      "orderId": "71ed606f-3119-4f9f-b7f7-ecd25740e15b",
      "email": "mila@example.com",
      "provider": "stripe",
      "providerName": "Stripe",
      "externalId": "dp_1QdZ8x2eZvKYlo2C",
      "reason": "fraudulent",
      "reasonText": "Says they did not make the payment",
      "stage": "chargeback",
      "providerStatus": "needs_response",
      "status": "needs_response",
      "amount": 49,
      "currency": "USD",
      "dueAt": "2026-10-27T16:20:19Z",
      "answer": {
        "state": "",
        "at": null,
        "by": "",
        "note": ""
      },
      "answeredFrom": "provider",
      "answerPlace": "your Stripe Dashboard",
      "accessTaken": false,
      "dateCreated": "2026-10-22T16:20:19Z",
      "dateClosed": null
    },
    {
      "id": "0f8aa05a-52c5-4fc5-8180-36aec2177869",
      "orderId": "cc9beefe-9e86-42db-8ef0-354c1ab48b0a",
      "email": "jonas@example.com",
      "provider": "paypal",
      "providerName": "PayPal",
      "externalId": "PP-D-27803",
      "reason": "merchandise_or_service_not_received",
      "reasonText": "Says it never arrived",
      "stage": "claim",
      "providerStatus": "waiting_for_seller_response",
      "status": "needs_response",
      "amount": 10,
      "currency": "USD",
      "dueAt": "2026-10-31T16:20:19Z",
      "answer": {
        "state": "",
        "at": null,
        "by": "",
        "note": ""
      },
      "answeredFrom": "provider",
      "answerPlace": "PayPal's Resolution Center",
      "accessTaken": false,
      "dateCreated": "2026-10-22T16:20:19Z",
      "dateClosed": null
    }
  ],
  "pages": 1,
  "total": 2,
  "meta": {
    "figures": {
      "needs": 2,
      "dueSoon": 0,
      "atRisk": 59,
      "won": 0,
      "lost": 0,
      "disputed": 2,
      "orders": 6,
      "currency": "USD",
      "days": 90
    },
    "providers": [
      {
        "id": "paypal",
        "name": "PayPal"
      },
      {
        "id": "stripe",
        "name": "Stripe"
      }
    ]
  }
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>",
  "data": null,
  "errors": {}
}

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

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"

page

integer

default:1

Which page of the list. The first is 1.

perPage

integer

default:20

How many a page holds.

Response

It worked.

success

boolean

message

unknown

code

unknown

data

object[]

Show child attributes

pages

integer

total

integer