v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Update Order

patch/sites/multiscreen/{site_name}/ecommerce/orders/{order_id}

Path parameters

site_namestring required

The unique identifier for the target Site.

order_idstring required

The unique identifier for the target Order.

Request body

emailstring

Email address of the shopper

metadataobject

shipping_instructionsstring

A detailed description of shipping instructions for the merchant.

Response

200

createdstring

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"
  },
  "created": "2024-03-19T17:09:47.231Z",
  "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",
    "card_last_4": "string",
    "currency": "string",
    "method": "string",
    "status": "PAID",
    "transaction_id": "string"
  },
  "refunds": [
    {
      "created": "2024-03-19T17:09:47.231Z",
      "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"
}