List orders - Shoply Documentation

Node.js

import Shoply from "@shoplygg/node";

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

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

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

<?php

require 'vendor/autoload.php';

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

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

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

package main

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

func main() {

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

	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}/orders")

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": "eab50b8e-fca6-4712-9b55-2f910b4bddf0",
      "dateCreated": "2026-10-22T16:20:19Z",
      "email": "ada@example.com",
      "customerId": "f637fc21-973d-43ec-a7db-f819a9ebf73a",
      "productId": "f463e265-097a-4235-bc2f-5239b19a9874",
      "productName": "Northwind Pro",
      "variantId": "00e1d395-9ba2-4db3-900a-cb5e2811a2a9",
      "variantName": "1 month",
      "itemCount": 1,
      "subtotal": 9.99,
      "discount": 0,
      "fee": 0,
      "balanceUsed": 0,
      "tax": null,
      "amount": 9.99,
      "currencyCode": "USD",
      "charged": null,
      "status": "pending",
      "gateway": "",
      "couponCode": null,
      "returning": false,
      "country": null,
      "billing": {
        "name": "",
        "line1": "",
        "line2": "",
        "city": "",
        "state": "",
        "postalCode": "",
        "country": ""
      },
      "ip": null,
      "userAgent": null,
      "source": "storefront",
      "subscriptionId": null,
      "transactionId": null,
      "paidAt": null,
      "note": "",
      "customFields": [],
      "emailState": "",
      "emailError": "",
      "emailAttempts": 0,
      "emailSentAt": null,
      "notifyState": "",
      "notifyError": "",
      "notifyAttempts": 0,
      "notifySentAt": null,
      "summary": "Northwind Pro (1 month)",
      "items": [
        {
          "id": "272733",
          "productId": "f463e265-097a-4235-bc2f-5239b19a9874",
          "productName": "Northwind Pro",
          "variantId": "00e1d395-9ba2-4db3-900a-cb5e2811a2a9",
          "variantName": "1 month",
          "amount": 9.99,
          "unitPrice": 9.99,
          "quantity": 1,
          "lineTotal": 9.99,
          "upsellId": null,
          "addonOf": null,
          "deliveredKeys": [],
          "redeliveryCount": 0,
          "lastRedeliveredAt": null,
          "deliveryInstructions": "",
          "dynamicState": "",
          "dynamicMessage": "",
          "dynamicItems": [],
          "previousDynamicItems": [],
          "dynamicDeliveredAt": null,
          "dynamicError": "",
          "dynamicAttempts": 0
        }
      ],
      "invoice": null
    }
  ],
  "pages": 1,
  "total": 1,
  "meta": {
    "stats": {
      "revenue": 0,
      "pendingValue": 9.99,
      "count": 1
    },
    "statusCounts": {
      "completed": 0,
      "pending": 1,
      "refunded": 0,
      "cancelled": 0,
      "chargeback": 0,
      "all": 1
    },
    "statuses": [
      "completed",
      "pending"
    ],
    "gateways": [],
    "currencyCode": "USD"
  }
}

{
  "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": {}
}

GET

stores

{storeId}

orders

Node.js

import Shoply from "@shoplygg/node";

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

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

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

<?php

require 'vendor/autoload.php';

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

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

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

package main

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

func main() {

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

	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}/orders")

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": "eab50b8e-fca6-4712-9b55-2f910b4bddf0",
      "dateCreated": "2026-10-22T16:20:19Z",
      "email": "ada@example.com",
      "customerId": "f637fc21-973d-43ec-a7db-f819a9ebf73a",
      "productId": "f463e265-097a-4235-bc2f-5239b19a9874",
      "productName": "Northwind Pro",
      "variantId": "00e1d395-9ba2-4db3-900a-cb5e2811a2a9",
      "variantName": "1 month",
      "itemCount": 1,
      "subtotal": 9.99,
      "discount": 0,
      "fee": 0,
      "balanceUsed": 0,
      "tax": null,
      "amount": 9.99,
      "currencyCode": "USD",
      "charged": null,
      "status": "pending",
      "gateway": "",
      "couponCode": null,
      "returning": false,
      "country": null,
      "billing": {
        "name": "",
        "line1": "",
        "line2": "",
        "city": "",
        "state": "",
        "postalCode": "",
        "country": ""
      },
      "ip": null,
      "userAgent": null,
      "source": "storefront",
      "subscriptionId": null,
      "transactionId": null,
      "paidAt": null,
      "note": "",
      "customFields": [],
      "emailState": "",
      "emailError": "",
      "emailAttempts": 0,
      "emailSentAt": null,
      "notifyState": "",
      "notifyError": "",
      "notifyAttempts": 0,
      "notifySentAt": null,
      "summary": "Northwind Pro (1 month)",
      "items": [
        {
          "id": "272733",
          "productId": "f463e265-097a-4235-bc2f-5239b19a9874",
          "productName": "Northwind Pro",
          "variantId": "00e1d395-9ba2-4db3-900a-cb5e2811a2a9",
          "variantName": "1 month",
          "amount": 9.99,
          "unitPrice": 9.99,
          "quantity": 1,
          "lineTotal": 9.99,
          "upsellId": null,
          "addonOf": null,
          "deliveredKeys": [],
          "redeliveryCount": 0,
          "lastRedeliveredAt": null,
          "deliveryInstructions": "",
          "dynamicState": "",
          "dynamicMessage": "",
          "dynamicItems": [],
          "previousDynamicItems": [],
          "dynamicDeliveredAt": null,
          "dynamicError": "",
          "dynamicAttempts": 0
        }
      ],
      "invoice": null
    }
  ],
  "pages": 1,
  "total": 1,
  "meta": {
    "stats": {
      "revenue": 0,
      "pendingValue": 9.99,
      "count": 1
    },
    "statusCounts": {
      "completed": 0,
      "pending": 1,
      "refunded": 0,
      "cancelled": 0,
      "chargeback": 0,
      "all": 1
    },
    "statuses": [
      "completed",
      "pending"
    ],
    "gateways": [],
    "currencyCode": "USD"
  }
}

{
  "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

page

integer

default:1

Which page of the list. The first is 1.

perPage

integer

default:20

How many a page holds, up to 100.

status

enum<string>

Only orders in this status.

Available options:

pending,

completed,

refunded,

cancelled,

chargeback

gateway

string

Only orders paid with this payment method, by its name in the payment methods list.

Example:

"stripe"

string

An order's ID, or part of a buyer's email.

sort

enum<string>

default:created_at

What the list is ordered by.

Available options:

created_at,

amount,

email,

status

direction

enum<string>

default:desc

Which way it is ordered.

Available options:

asc,

desc

range

enum<string>

Only orders placed in this period.

Available options:

today,

yesterday,

7d,

30d,

this_week,

last_week,

this_month,

last_month,

this_year

from

string

Only orders placed on or after this day, as YYYY-MM-DD. With to, in place of range.

Example:

"2026-10-01"

string

Only orders placed on or before this day, as YYYY-MM-DD.

Example:

"2026-10-31"

string

The time zone the days of range, from and to are in, as an IANA name. Left out, UTC.

Example:

"Europe/Berlin"

Response

It worked.

success

boolean

message

unknown

code

unknown

data

object[]

Show child attributes

pages

integer

total

integer