Orders API reference

Reference map for Orders API operations.

Updated
Apr 26, 2026

Orders

Use the section that matches your caller: storefront clients use Shopper REST or Search, trusted services use Management, and signed-in customer flows use Auth.

Use Orders when the job is about order records, order lines, status transitions, order history, sales metrics, or authenticated order lookup.

Management API order operations own trusted back-office order creation, updates, cancellation, line edits, status changes, history, merchant-user views, and metrics. Auth API order routes are read-only lookup surfaces for authenticated users or service-token app lookup.

Use order-line operations when the contents of an order are changing. Use order status operations when fulfillment or lifecycle state is changing. Use Auth API reads when the caller is retrieving existing order information through customer or service-token context.

For workflow guidance across order records, lines, status changes, account reads, metrics, and events, see Orders and order lines.

Management API · read, create, update, and remove

Read and inspect

OperationAPI
Get order by IDManagement API
Get order historyManagement API
Get order linesManagement API
Get sales metricsManagement API
List all ordersManagement API
List orders by merchant userManagement API

Create or attach

OperationAPI
Create orderManagement API
Create order lineManagement API

Update or repair

OperationAPI
Update orderManagement API
Update order lineManagement API
Update order statusManagement API

Remove or deactivate

OperationAPI
Cancel orderManagement API
Delete order lineManagement API

Auth API · read

Read and inspect

Orders API reference

# Orders Use the section that matches your caller: storefront clients use Shopper REST or Search, trusted services use Management, and signed-in customer flows use Auth. Use Orders when the job is about order records, order lines, status transitions, order history, sales metrics, or authenticated order lookup. Management API order operations own trusted back-office order creation, updates, cancellation, line edits, status changes, history, merchant-user views, and metrics. Auth API order routes are read-only lookup surfaces for authenticated users or service-token app lookup. Use order-line operations when the contents of an order are changing. Use order status operations when fulfillment or lifecycle state is changing. Use Auth API reads when the caller is retrieving existing order information through customer or service-token context. For workflow guidance across order records, lines, status changes, account reads, metrics, and events, see [Orders and order lines](/start/concepts/orders-and-order-lines).

19 operations grouped by API, then by the job they support.

## Management API · read, create, update, and remove ### Read and inspect | Operation | API | | --- | --- | | [Get order by ID](/reference/orders/get-order-by-id) | Management API | | [Get order history](/reference/orders/get-order-history) | Management API | | [Get order lines](/reference/orders/get-order-lines) | Management API | | [Get sales metrics](/reference/orders/get-sales-metrics) | Management API | | [List all orders](/reference/orders/list-all-orders) | Management API | | [List orders by merchant user](/reference/orders/list-orders-by-merchant-user) | Management API | ### Create or attach | Operation | API | | --- | --- | | [Create order](/reference/orders/create-order) | Management API | | [Create order line](/reference/orders/create-order-line) | Management API | ### Update or repair | Operation | API | | --- | --- | | [Update order](/reference/orders/update-order) | Management API | | [Update order line](/reference/orders/update-order-line) | Management API | | [Update order status](/reference/orders/update-order-status) | Management API | ### Remove or deactivate | Operation | API | | --- | --- | | [Cancel order](/reference/orders/cancel-order) | Management API | | [Delete order line](/reference/orders/delete-order-line) | Management API | ## Auth API · read ### Read and inspect | Operation | API | | --- | --- | | [Get order by ID for an app](/reference/orders/get-order-by-id-for-an-app) | Auth API | | [Get order by ID for authenticated user](/reference/orders/get-order-by-id-for-authenticated-user) | Auth API | | [Get order by reference for an app](/reference/orders/get-order-by-reference-for-an-app) | Auth API | | [Get order by reference for authenticated user](/reference/orders/get-order-by-reference-for-authenticated-user) | Auth API | | [List all orders for an app](/reference/orders/list-all-orders-for-an-app) | Auth API | | [List orders for authenticated user](/reference/orders/list-orders-for-authenticated-user) | Auth API |