Skip to main content
GET
/
orders
List orders
curl --request GET \
  --url https://store.salesive.com/api/v1/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "status": 123,
  "success": true,
  "message": "<string>",
  "data": {
    "orders": [
      {
        "_id": "<string>",
        "orderId": 123,
        "user": "<string>",
        "shop": "<string>",
        "items": [
          {
            "product": "<string>",
            "name": "<string>",
            "price": 123,
            "quantity": 2,
            "variant": "<string>",
            "sku": "<string>",
            "variantAttributes": {},
            "imageUrl": "<string>"
          }
        ],
        "subtotal": 123,
        "shippingCost": 123,
        "total": 123,
        "shippingAddress": {
          "fullName": "<string>",
          "addressLine1": "<string>",
          "city": "<string>",
          "state": "<string>",
          "zipCode": "<string>",
          "country": "<string>",
          "phoneNumber": "<string>",
          "addressLine2": "<string>"
        },
        "payment": "<string>",
        "shipment": "<string>",
        "notes": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "page": 123,
      "limit": 123,
      "total": 123,
      "pages": 123
    }
  }
}
Returns the store’s orders most recent first, each enriched with the customer, payment, coupon and shipment summaries. The store is bound to your app token server-side — never send a shop id.

Authorizations

Authorization
string
header
required

JWT issued by the Salesive Store API for authenticated shoppers.

x-shop-id
string
header
required

Optional storefront identifier sent as a header to scope responses to a specific shop. Try It requests remember this value once provided.

Headers

x-shop-id
string

Optional identifier that scopes responses to a specific storefront when the referer cannot be inferred.

Query Parameters

status
enum<string>

Filter by order status. Can be specified multiple times.

Available options:
pending,
processing,
paid,
cancelled,
refunded
orderId
integer

Filter by specific order ID.

minTotal
number

Filter orders with total greater than or equal to this value.

maxTotal
number

Filter orders with total less than or equal to this value.

from
string<date-time>

Filter orders created after this date (ISO 8601 format).

to
string<date-time>

Filter orders created before this date (ISO 8601 format).

page
integer
default:1

Page number for pagination (default: 1).

Required range: x >= 1
limit
integer
default:10

Number of items per page (default: 10).

Required range: x >= 1

Response

Orders retrieved successfully.

status
integer
required
success
boolean
required
message
string
required
data
object
required