---
title: Draft Order API
description: |
  
  The Draft Order API provides an extension with data about the current draft order.


  #### Supporting targets
  - [pos.draft-order-details.action.menu-item.render](/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-action-menu-item-render)
  - [pos.draft-order-details.action.render](/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-action-render)
  - [pos.draft-order-details.block.render](/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-block-render)
api_version: 2025-10
api_name: pos-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/pos-ui-extensions/latest/apis/draft-order-api
  md: https://shopify.dev/docs/api/pos-ui-extensions/latest/apis/draft-order-api.md
---

# Draft Order APIAPIs

The Draft Order API provides an extension with data about the current draft order.

#### Supporting targets

* [pos.draft-order-details.action.menu-item.render](https://shopify.dev/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-action-menu-item-render)
* [pos.draft-order-details.action.render](https://shopify.dev/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-action-render)
* [pos.draft-order-details.block.render](https://shopify.dev/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-block-render)

## DraftOrderApi

* id

  number

  required

  The unique identifier for the draft order

* name

  string

  required

  The name of the draft order

* customerId

  number

  The unique identifier of the customer associated with the draft order

## Examples

Examples of using the Draft Order API.

Retrieve the ID of the draft order.

### Examples

* #### Retrieve the ID of the draft order.

  ##### jsx

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

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

  const Extension = () => {
    return (
      <s-page heading='Draft Order Details Action'>
        <s-scroll-box>
          <s-text>Order ID: {shopify.draftOrder.id}</s-text>
        </s-scroll-box>
      </s-page>
    );
  };
  ```