Skip to main content
GET
/
orders
/
{id}
Get order by ID
curl --request GET \
  --url https://store.salesive.com/api/v1/orders/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-shop-id: <api-key>'
{
  "status": 123,
  "success": true,
  "message": "<string>",
  "data": {
    "_id": "<string>",
    "orderId": 123,
    "user": "<string>",
    "shop": "<string>",
    "items": [
      {
        "product": "<string>",
        "name": "<string>",
        "price": 123,
        "quantity": 2,
        "variant": "<string>",
        "sku": "<string>",
        "variantAttributes": {},
        "imageUrl": "<string>"
      }
    ],
    "status": "pending",
    "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"
  }
}

​
Request

GET /orders/{id}
Authorization: Bearer {{token}}
x-shop-id: {{shopId}}

​
Headers

HeaderTypeDescription
AuthorizationstringProvide the customer token in the format Bearer <jwt>.
x-shop-idstringIdentify the shop that owns the order.

​
Path parameters

ParameterTypeDescription
idstringThe ID of the order to retrieve

​
Request examples

​
Get order by ID

GET /orders/690ff00acf4de460fd1f6114

​
Successful response

{
    "status": 200,
    "success": true,
    "message": "Order retrieved",
    "data": {
        "_id": "690ff00acf4de460fd1f6114",
        "orderId": 1001,
        "user": "68f976e92bb0b821425fdda6",
        "shop": "68b8f52575da81b332af29f1",
        "items": [
            {
                "product": "68e5bb463a1fc56a8ac150bf",
                "name": "Head phone",
                "price": 10000,
                "quantity": 2
            }
        ],
        "status": "pending",
        "subtotal": 20000,
        "shippingCost": 0,
        "total": 20000,
        "createdAt": "2025-11-14T15:30:00.000Z",
        "updatedAt": "2025-11-14T15:30:00.000Z"
    }
}

​
Error responses

​
401 Unauthorized

{
    "status": 401,
    "success": false,
    "message": "Authentication required",
    "data": {}
}

​
403 Forbidden

{
    "status": 403,
    "success": false,
    "message": "Access denied",
    "data": {}
}

​
404 Not Found

{
    "status": 404,
    "success": false,
    "message": "Order not found",
    "data": {}
}

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.

Path Parameters

​
id
string
required

The ID of the order to retrieve

Response

Order retrieved successfully.

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