Skip to main content
GET
/
orders
cURL
curl --request GET \
  --url https://api.juo.io/customer/v1/orders \
  --header 'X-Delegated-Token: <api-key>' \
  --header 'X-Tenant-ID: <x-tenant-id>'
{
  "orders": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "placedAt": "<unknown>",
      "currencyCode": "<string>",
      "type": "checkout",
      "paymentStatus": "paid",
      "subtotal": "<unknown>",
      "shipping": "<unknown>",
      "totalPrice": "<unknown>",
      "taxesAmount": "<unknown>",
      "taxesIncluded": "<unknown>",
      "items": [
        {
          "id": "<string>",
          "title": "<string>",
          "subtitle": "<unknown>",
          "quantity": 2,
          "unitPrice": 1,
          "totalPrice": 1,
          "productId": "<unknown>",
          "variantId": "<unknown>",
          "sku": "<unknown>",
          "variantImage": "<unknown>",
          "subscriptionLineId": "<unknown>",
          "requiresShipping": true,
          "taxable": true,
          "customAttributes": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "sellingPlanId": "<unknown>",
          "sellingPlanName": "<unknown>"
        }
      ],
      "discounts": [
        {
          "id": "<string>",
          "title": "<unknown>",
          "type": "Code",
          "target": "Line",
          "value": {
            "type": "Percentage",
            "percentage": 50
          },
          "entitledItems": {
            "all": true
          },
          "subscriptionDiscountId": "<unknown>"
        }
      ],
      "deliveryMethod": "<unknown>",
      "paymentMethod": "<unknown>",
      "note": "<unknown>",
      "customAttributes": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "subscriptionIds": [
        "<string>"
      ]
    }
  ]
}

Authorizations

X-Delegated-Token
string
header
required

Headers

X-Tenant-ID
string
required

Unique identifier of the tenant in the system (usually a store identifier)

Query Parameters

query
string

The search query string. See search query language for information how to build the search query. Supported fields are listed here.

Minimum string length: 1
limit
integer
default:20

See pagination for more details on how to paginate the results.

Required range: 1 <= x <= 50
after
string

See pagination for more details on how to paginate the results.

Minimum string length: 1
before
string

See pagination for more details on how to paginate the results.

Minimum string length: 1

Response

200 - application/json

Default Response

orders
Order · object[]
required