---
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. The API offers order details for implementing order-specific
  functionality and workflows.
api_version: 2025-10
api_name: pos-ui-extensions
source_url:
  html: >-
    https://shopify.dev/docs/api/pos-ui-extensions/latest/target-apis/contextual-apis/order-api
  md: >-
    https://shopify.dev/docs/api/pos-ui-extensions/latest/target-apis/contextual-apis/order-api.md
---

# Order APIAPIs

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.

## OrderApi

The `OrderApi` object provides access to order data. Access this property through `shopify.order` to interact with the current order context.

* 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.

## 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.

## Examples

Learn how to access order information in order detail contexts.

### Examples

* #### Retrieve an order ID

  ##### 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

  ```jsx
  import {render} from 'preact';

  export default async () => {
    render(<Extension />, document.body);
  };

  const Extension = () => {
    return (
      <s-page heading="Order Api">
        <s-scroll-box>
          <s-text>Order ID: {shopify.order.id}</s-text>
        </s-scroll-box>
      </s-page>
    );
  };
  ```

* #### Retrieve an order's name, ID, and associated customer 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

  ```jsx
  import {render} from 'preact';

  export default async () => {
    render(<Extension />, document.body);
  };

  const Extension = () => {
    const {id, name, customerId} = shopify.order;

    return (
      <s-page heading="Order Details">
        <s-scroll-box>
          <s-stack direction="block">
            <s-text>Order ID: {id}</s-text>
            <s-text>Order Name: {name}</s-text>
            {customerId ? (
              <s-text>Customer ID: {customerId}</s-text>
            ) : (
              <s-text>No customer associated with this order</s-text>
            )}
          </s-stack>
        </s-scroll-box>
      </s-page>
    );
  };
  ```