Get Order

Retrieve a specific order from your store by its ID

GET /orders/{id}

Get Order

cURL

curl --request GET \
  --url https://api-ai.textyess.com/orders/{id} \
  --header 'x-auth-token: <api-key>'

200

{
  "id": "order_12345",
  "number_of_items": 3,
  "total_price": "99.99",
  "paid": true,
  "created_at": "2024-03-20T10:30:00Z"
}

Overview

The get order endpoint allows you to retrieve detailed information about a specific order in your store using its unique identifier. This endpoint returns the most recent order matching the provided ID.

Authentication

This endpoint requires a valid JWT token in the x-auth-token header. You can find your token in the Developers section:

x-auth-token: your_jwt_token

Path Parameters

id · string · required

The unique identifier (cms_id) of the order you want to retrieve

Response

The response includes the following fields:

id · string

The unique identifier (cms_id) of the order

number_of_items · number

The total number of items in the order

total_price · string

The total price of the order in decimal format (e.g., “99.99”)

paid · boolean

Indicates if the order has been paid

created_at · string

The timestamp when the order was created

200

{
  "id": "order_12345",
  "number_of_items": 3,
  "total_price": "99.99",
  "paid": true,
  "created_at": "2024-03-20T10:30:00Z"
}