Sign in

v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Create External Order

post/sites/multiscreen/{site_name}/ecommerce/orders

Path parameters

site_namestring required

Unique ID of the site.

Request body

createdstring

The date and time when the order was placed

currencystring required

Currency ISO code of the order

emailstring required

email of the person ordering

external_idstring

External reference to the order

inventory_sync_strategy'IGNORE' | 'SYNC'
invoice_numberstring required

Unique bureaucratic reference to the order. The invoice number need to be a unique value for all orders on a site

ip_addressstring

The IP address from which the order was placed

mode'LIVE' | 'TEST' required
shipping_instructionsstring

Special instructions left by the customer for the delivery

status'IN_PROGRESS' | 'PROCESSED' | 'SHIPPED' | 'DELIVERED' | 'PENDING' | 'CANCELLED' | 'DISPATCHED' required
user_agentstring

User agent of the customer when placed the order

Response

200

cancellation_reasonstring
cancelledstring
createdstring
customer_accepts_marketingboolean
emailstring
external_idstring
idstring
invoice_numberstring
ip_addressstring
metadatastring
modestring
shipping_instructionsstring
sourcestring
statusstring
subtotalinteger
totalinteger
tracking_numberstring
tracking_urlstring
user_agentstring

Example response

{
  "billing_address": {
    "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": "2025-03-25T17:25:05.034Z",
  "created": "2025-03-25T17:25:05.034Z",
  "customer_accepts_marketing": true,
  "discounts": [
    {
      "id": "string",
      "name": "string",
      "type": "string"
    }
  ],
  "email": "string",
  "external_id": "string",
  "id": "string",
  "invoice_number": "string",
  "ip_address": "string",
  "items": [
    {
      "external_product_id": "string",
      "external_variation_id": "string",
      "id": "string",
      "image": "string",
      "metadata": "string",
      "name": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "product_id": "string",
      "shippable": true,
      "sku": "string",
      "variation_id": "string"
    }
  ],
  "metadata": "string",
  "mode": "LIVE",
  "payment": {
    "card_brand": "NULL",
    "confirmed_method": {
      "details": "string",
      "display_name": "string",
      "gateway": "NONE",
      "icon": "string",
      "instructions": "string",
      "name": "UNKNOWN"
    },
    "currency": "string",
    "status": "PAID",
    "transaction_id": "string"
  },
  "refunds": [
    {
      "created": "2025-03-25T17:25:05.034Z",
      "currency": "string",
      "id": "string",
      "items": [
        {
          "id": "string",
          "taxes": [
            {
              "id": "string",
              "name": "string",
              "provider": "BUILT_IN"
            }
          ]
        }
      ],
      "order_id": "string",
      "reason": "string",
      "tax_provider": {
        "avalara_reference_id": "string",
        "provider": "BUILT_IN"
      },
      "taxes": [
        {
          "id": "string",
          "name": "string",
          "provider": "BUILT_IN"
        }
      ],
      "transaction_id": "string"
    }
  ],
  "shipping_address": {
    "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": {
    "name": "string"
  },
  "source": "CHECKOUT",
  "status": "IN_PROGRESS",
  "taxes": [
    {
      "name": "string"
    }
  ],
  "tracking_number": "string",
  "tracking_url": "string",
  "user_agent": "string"
}