orders
General
Offset

Get Order By Offset

Retrieve an order relative to another order display ID using an offset.

Overview

  • Method: GET
  • Path: /get-order-by-offset/:orderDisplayId/:offset
  • Tags: orders, brand

Parameters

orderDisplayId (path)

  • Type: number
  • Required: Yes
  • Description: No description

offset (path)

  • Type: number
  • Required: Yes
  • Description: No description

Request Body

No request body required.

Responses

200

Success

Content Type: application/json

{
  "nextOrder": {
    "id": "string",
    "display_id": 123,
    "status": "string",
    "total": 123,
    "subtotal": 123,
    "tax_total": 123,
    "shipping_total": 123,
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z",
    "customer": {
      "id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string"
    }
  }
}

400

Validation error

Content Type: application/json

{
  "error": "string",
  "details": [
    {}
  ]
}

Example Usage

curl -X GET \
  https://api.pillexa.com/get-order-by-offset/:orderDisplayId/:offset \
  -H "Content-Type: application/json" \
StatemachinetypeTagid