v1

latestOpenAPI 3.1.0CC-BY-NC-SA-4.02026-07-2413803.8 MB

Orders API

Get order

⚠️ We no longer recommend using the Orders API. Please refer to the Payments API instead.

Retrieve a single order object by its ID.

🔑 Access with

API key

Advanced access token with orders.read

OAuth access with orders.read

get/orders/{orderId}

Query parameters

embed'payments' | 'refunds' | 'shipments'

Example:payments

This endpoint allows embedding related API items by appending the following values via the embed query string parameter.

testmodeboolean

Most API credentials are specifically created for either live mode or test mode. In those cases the testmode query parameter must not be sent. For organization-level credentials such as OAuth access tokens, you can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Response

The order object.