---
title: "Create External Order"
method: POST
path: "/sites/multiscreen/{site_name}/ecommerce/orders"
---

# Create External Order

`POST /sites/multiscreen/{site_name}/ecommerce/orders`

## Path parameters

- `site_name` string, required

## Request body

- object
  - `billing_address` object, required
    - `address_1` string, required — Line 1 of the address for billing details.
    - `address_2` string — Line 2 of the address for billing details. This is not always set.
    - `city` string, required — City of the billing address
    - `country` string — Country where the order took place.
    - `first_name` string — First name of the shopper's billing address/details.
    - `full_name` string — Full name name of the shopper's billing address/details.
    - `last_name` string — Last name of the shopper's billing address/details.
    - `phone` string
    - `postal_code` string, required
    - `region` string — Region, state or other area for the billing address.
    - `street_name` string — Street name for the billing address
    - `street_number` string — The street number for the address.
    - `sub_locality` string — The related sub_locality of the billing address. Often empty.
  - `created` string — The date and time when the order was placed
  - `currency` string, required — Currency ISO code of the order
  - `email` string, required — email of the person ordering
  - `external_id` string — External reference to the order
  - `inventory_sync_strategy` 'IGNORE' | 'SYNC'
  - `invoice_number` string, required — Unique bureaucratic reference to the order. The invoice number need to be a unique value for all orders on a site
  - `ip_address` string — The IP address from which the order was placed
  - `items` object[], required — items bought with the order
    - `external_product_id` string
    - `external_variation_id` string
    - `image` string — URL of the primary product image
    - `name` string, required — name of the product
    - `options` object[]
      - `choices` object[] — Allowed choices to select from
        - `id` string — Immutable identifier for referencing
        - `value` string — Option choice value
      - `id` string — A unique identifier for the option
      - `name` string — The name of the option
    - `product_id` string, required — ID of the product in the catalogue
    - `quantity` integer, required — number of items ordered
    - `shippable` boolean
    - `unit_dimensions` object
      - `height` integer
      - `length` integer
      - `width` integer
    - `unit_price` integer, required — Unit price of the item
    - `unit_weight` integer
    - `variation_id` string, required
  - `metadata` object — Merchant defined JSON data for the whole order
    - `key` string — Add/edit the key:value pairs.
  - `mode` 'LIVE' | 'TEST', required
  - `payment` object
    - `transaction_id` string, required — External reference of a payment transaction associated to this order
  - `shipping_address` object
    - `address_1` string, required — Line 1 of the address for billing details.
    - `address_2` string — Line 2 of the address for billing details. This is not always set.
    - `city` string, required — City of the billing address
    - `country` string — Country where the order took place.
    - `first_name` string — First name of the shopper's billing address/details.
    - `full_name` string — Full name name of the shopper's billing address/details.
    - `last_name` string — Last name of the shopper's billing address/details.
    - `phone` string
    - `postal_code` string, required
    - `region` string — Region, state or other area for the billing address.
    - `street_name` string — Street name for the billing address
    - `street_number` string — The street number for the address.
    - `sub_locality` string — The related sub_locality of the billing address. Often empty.
  - `shipping_instructions` string — Special instructions left by the customer for the delivery
  - `shipping_method` object
    - `cost` number, double, required — The cost incurred for the order by the shipping method.
    - `name` string, required — Name of the shipping method selected on the order.
  - `status` 'IN_PROGRESS' | 'PROCESSED' | 'SHIPPED' | 'DELIVERED' | 'PENDING' | 'CANCELLED' | 'DISPATCHED', required
  - `user_agent` string — User agent of the customer when placed the order

## Response `200`

200

- object
  - `billing_address` object
    - `address_1` string
    - `address_2` string
    - `city` string
    - `country` string
    - `first_name` string
    - `full_name` string
    - `last_name` string
    - `phone` string
    - `postal_code` string
    - `region` string
    - `street_name` string
    - `street_number` string
    - `sub_locality` string
  - `cancellation_reason` string
  - `cancelled` string
  - `created` string
  - `customer_accepts_marketing` boolean
  - `discounts` object[]
    - `id` string
    - `name` string
    - `savings` integer
    - `type` string
  - `email` string
  - `external_id` string
  - `id` string
  - `invoice_number` string
  - `ip_address` string
  - `items` object[]
    - `combined_weight` integer
    - `external_product_id` string
    - `external_variation_id` string
    - `id` string
    - `image` string
    - `metadata` string
    - `name` string
    - `options` object[]
      - `name` string
      - `value` string
    - `product_id` string
    - `quantity` integer
    - `shippable` boolean
    - `sku` string
    - `total` integer
    - `unit_dimensions` object
      - `height` integer
      - `length` integer
      - `width` integer
    - `unit_price` integer
    - `unit_weight` integer
    - `variation_id` string
  - `metadata` string
  - `mode` string
  - `payment` object
    - `card_brand` string
    - `confirmed_method` object
      - `details` string
      - `display_name` string
      - `gateway` string
      - `icon` string
      - `instructions` string
      - `name` string
    - `currency` string
    - `status` string
    - `transaction_id` string
  - `refunds` object[]
    - `created` string
    - `currency` string
    - `id` string
    - `items` object[]
      - `amount` integer
      - `id` string
      - `quantity` integer
      - `taxes` object[]
        - `amount` integer
        - `id` string
        - `name` string
        - `provider` string
        - `rate` integer
    - `order_id` string
    - `reason` string
    - `subtotal` integer
    - `tax_provider` object
      - `avalara_reference_id` string
      - `provider` string
    - `taxes` object[]
      - `amount` integer
      - `id` string
      - `name` string
      - `provider` string
      - `rate` integer
    - `total` integer
    - `transaction_id` string
  - `shipping_address` object
    - `address_1` string
    - `address_2` string
    - `city` string
    - `country` string
    - `first_name` string
    - `full_name` string
    - `last_name` string
    - `phone` string
    - `postal_code` string
    - `region` string
    - `street_name` string
    - `street_number` string
    - `sub_locality` string
  - `shipping_instructions` string
  - `shipping_method` object
    - `cost` integer
    - `name` string
  - `source` string
  - `status` string
  - `subtotal` integer
  - `taxes` object[]
    - `amount` integer
    - `name` string
    - `rate` integer
  - `total` integer
  - `tracking_number` string
  - `tracking_url` string
  - `user_agent` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/duda/apis/partner-api.md) · [All operations](https://skmtc.net/duda/apis/partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/duda/partner-api/versions/5b9208270ed1/schema)