---
title: Order API
description: >-
The Order API provides read-only access to order data. Use this API to get
order information and build contextual experiences based on the selected order
context.
api_version: 2026-07-rc
source_url:
html: >-
https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/target-apis/contextual-apis/order-api
md: >-
https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/target-apis/contextual-apis/order-api.md
---
# Order API
The Order API provides read-only access to order data. Use this API to get order information and build contextual experiences based on the selected order context. The API offers order details for implementing order-specific functionality and workflows.
### Use cases
* **Order access:** Access the order identifier to implement order-specific functionality.
* **Order display:** Build extensions showing order information or management tools.
* **Contextual UI:** Create interfaces that adapt based on the current order context.
* **External integrations:** Link order data with external systems or order management platforms.
### Support Targets (12)
### Supported targets
* [pos.exchange.post.action.menu-item.render](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/targets/post-exchange#post-exchange-action-menu-item-)
* [pos.exchange.post.action.render](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/targets/post-exchange#post-exchange-action-modal-)
* [pos.exchange.post.block.render](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/targets/post-exchange#post-exchange-targets)
* [pos.order-details.action.menu-item.render](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/targets/order-details#order-details-action-menu-item-)
* [pos.order-details.action.render](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/targets/order-details#order-details-action-modal-)
* [pos.order-details.block.render](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/targets/order-details#order-details-targets)
* [pos.purchase.post.action.menu-item.render](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/targets/post-purchase#post-purchase-action-menu-item-)
* [pos.purchase.post.action.render](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/targets/post-purchase#post-purchase-action-modal-)
* [pos.purchase.post.block.render](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/targets/post-purchase#post-purchase-targets)
* [pos.return.post.action.menu-item.render](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/targets/post-return#post-return-action-menu-item-)
* [pos.return.post.action.render](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/targets/post-return#post-return-action-modal-)
* [pos.return.post.block.render](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc/targets/post-return#post-return-targets)
### Properties
The [`shopify` global object](https://shopify.dev/docs/api/pos-ui-extensions/2026-07-rc#target-apis-define-what-your-extension-does) provides access to order data for the active context. Access the following properties on `shopify` to get order information including the order identifier, name, and associated customer.
* **id**
**number**
**required**
The unique identifier for the order. Use for order lookups, implementing order-specific functionality, and integrating with external systems.
* **name**
**string**
**required**
The name of the order as configured by the merchant. Use for order identification, displays, and customer-facing interfaces.
* **customerId**
**number**
The unique identifier of the customer associated with the order. Returns `undefined` if no customer is associated. Use for customer-specific functionality and personalized experiences.
Examples
### Examples
* ####
##### Description
Access the unique identifier of the current order in an order detail action context. This example shows how to use \`shopify.order.id\` to retrieve the order ID. This can be used for fetching additional order data, tracking, or implementing order-specific functionality and post-purchase workflows.
##### jsx
```tsx
import {render} from 'preact';
export default async () => {
render(, document.body);
};
const Extension = () => {
return (
Order ID: {shopify.order.id}
);
};
```
* ####
##### Description
Access multiple order properties including the order name and customer ID. This example demonstrates accessing \`shopify.order.id\`, \`shopify.order.name\`, and \`shopify.order.customerId\` to display comprehensive order information. Use this pattern for order management workflows and customer service features.
##### jsx
```tsx
import {render} from 'preact';
export default async () => {
render(, document.body);
};
const Extension = () => {
const {id, name, customerId} = shopify.order;
return (
Order ID: {id}
Order Name: {name}
{customerId ? (
Customer ID: {customerId}
) : (
No customer associated with this order
)}
);
};
```
***
## Best practices
* **Use order ID for data lookups:** Use the order ID to fetch additional order information from external systems, order management platforms, or Shopify APIs when building comprehensive order experiences.
* **Implement order-specific features:** Use the order context to enable specialized functionality like order fulfillment, customer communication, or order modification workflows.
* **Validate order access:** Verify that the order ID is valid before performing order-specific operations or external API calls.
***
## Limitations
Order data reflects the current POS session and may not include real-time updates from other channels until the session is refreshed.
***