---
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)
api_version: 2024-07
api_name: pos-ui-extensions
source_url:
  html: https://shopify.dev/docs/api/pos-ui-extensions/2024-07/apis/draft-order-api
  md: https://shopify.dev/docs/api/pos-ui-extensions/2024-07/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)

## DraftOrderApi

* id

  number

  required

  The unique identifier for the order

* name

  string

  required

  The name of the order

* customerId

  number

  The unique identifier of the customer associated with the order

## Examples

Examples of using the Draft Order API.

Retrieve the ID of the draft order.

### Examples

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

  ##### React

  ```tsx
  import React from 'react';

  import {
    Text,
    Screen,
    ScrollView,
    Navigator,
    reactExtension,
    useApi,
  } from '@shopify/ui-extensions-react/point-of-sale';

  const Modal = () => {
    const api = useApi<'pos.draft-order-details.action.render'>();
    return (
      <Navigator>
        <Screen name="DraftOrderDetailsAction" title="Draft Order Details Action">
          <ScrollView>
            <Text>{`Order ID: ${api.draftOrder.id}`}</Text>
          </ScrollView>
        </Screen>
      </Navigator>
    );
  };

  export default reactExtension('pos.draft-order-details.action.render', () => (
    <Modal />
  ));
  ```

  ##### TS

  ```ts
  import {
    Navigator,
    Screen,
    ScrollView,
    Text,
    extension,
  } from '@shopify/ui-extensions/point-of-sale';

  export default extension(
    'pos.draft-order-details.action.render',
    (root, api) => {
      const navigator = root.createComponent(Navigator);
      const screen = root.createComponent(Screen, {
        name: 'DraftOrderDetailsAction',
        title: 'Draft Order Details Action',
      });
      const scrollView = root.createComponent(ScrollView);
      const text = root.createComponent(Text);

      text.append(`ID for current draft order screen: ${api.draftOrder.id}`);
      scrollView.append(text);
      screen.append(scrollView);
      navigator.append(screen);
      root.append(navigator);
    },
  );
  ```