Order API

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

  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>
    );
  };

• 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

  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>
    );
  };