Skip to content
elasticStageDeveloper Portal

Get an order by ID.

GET
/v1/orders/{id}
curl --request GET \
  --url https://api.staging.elasticstage.com/store/v1/orders/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string
status
required
string
Allowed values: pending processing shipped delivered cancelled payment_failed
source
required
object
platform
required
string
store_id
Any of:
string
external_order_id
Any of:
string
total
required
object
amount
required
integer
<= 9007199254740991
currency
required
string
Allowed values: GBP USD EUR JPY
item_count
required
integer
<= 9007199254740991
line_items
required
Array<object>
object
sku
required
string
title
required
string
quantity
required
integer
>= 1 <= 9007199254740991
unit_price
required

The unit price the merchant charged the customer, as supplied in the POST /v1/orders payload. The order total is the sum of these across all items, plus shipping.

object
amount
required
integer
<= 9007199254740991
currency
required
string
Allowed values: GBP USD EUR JPY
shipping_address
required
object
full_name
Any of:
string
company
Any of:
string
address_line_1
required
string
address_line_2
Any of:
string
city
required
string
postal_code
Any of:
string
province_code
Any of:
string
country_code
required
string
billing
required
Any of:
object
method
required
string
Allowed values: enterprise_invoice credit_card
payment_status
required
string
Allowed values: paid rejected pending none
charged_at
required
Any of:
string format: date-time
shipping
required
object
rate_id
required
string
amount
required
object
amount
required
integer
<= 9007199254740991
currency
required
string
Allowed values: GBP USD EUR JPY
tracking
required
Any of:
object
carrier
required
string
tracking_number
required
Any of:
string
tracking_url
required
Any of:
string format: uri
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example
{
  "id": "ord_3a9f21",
  "status": "processing",
  "source": {
    "platform": "shopify_app",
    "store_id": "1234",
    "external_order_id": "1234"
  },
  "total": {
    "amount": 8599,
    "currency": "GBP"
  },
  "item_count": 2,
  "line_items": [
    {
      "sku": "LUM-ME-12-001",
      "title": "Midnight Echoes",
      "quantity": 2,
      "unit_price": {
        "amount": 3900,
        "currency": "GBP"
      }
    }
  ],
  "shipping_address": {
    "full_name": "Ada Lovelace",
    "address_line_1": "12 Baggot Street",
    "city": "Dublin",
    "postal_code": "D02 X285",
    "country_code": "IE"
  },
  "billing": {
    "method": "credit_card",
    "payment_status": "paid",
    "charged_at": "2026-02-01T15:22:05.000Z"
  },
  "shipping": {
    "rate_id": "standard_eu",
    "amount": {
      "amount": 799,
      "currency": "GBP"
    }
  },
  "tracking": null,
  "created_at": "2026-02-01T15:22:00.000Z",
  "updated_at": "2026-02-01T15:22:05.000Z"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "statusCode": 401,
  "code": "UNAUTHORIZED",
  "error": "Unauthorized",
  "message": "Authentication required."
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "statusCode": 403,
  "code": "FORBIDDEN",
  "error": "Forbidden",
  "message": "Insufficient permissions."
}

404

Section titled “404”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "statusCode": 404,
  "code": "NOT_FOUND",
  "error": "Not Found",
  "message": "The requested resource was not found."
}

429

Section titled “429”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "statusCode": 429,
  "code": "RATE_LIMITED",
  "error": "Too Many Requests",
  "message": "Rate limit exceeded."
}

500

Section titled “500”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "statusCode": 500,
  "code": "INTERNAL_ERROR",
  "error": "Internal Server Error",
  "message": "An unexpected error occurred."
}

503

Section titled “503”

Default Response

Media typeapplication/json
object
statusCode
required
number
code
required
string
Allowed values: VALIDATION_ERROR UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_ENTITY RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL_ERROR
error
required
string
message
required
string
details
Array
Example
{
  "statusCode": 503,
  "code": "SERVICE_UNAVAILABLE",
  "error": "Service Unavailable",
  "message": "The service is temporarily unavailable."
}