Lana Docs - POST:orders.json

Description

Modify an order.

While this API follows "multiple objects" convention, operations only on one order are allowed at a time.

Permission bit: "orders.modify"

Topic: Orders

Query Parameters

ids: Comma-separated array of String, required

List of order ids. See also: Unique Identifiers

Example: ?ids=or_EQzGqWoY,or_EQzGqWoY

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

updated_at: String

uuid: String

Request Body

Array of OrderModify


[
  {
    "billing_address": {
      "address1": "Chestnut Street 92",
      "address2": "Apartment 2",
      "city": "Louisville",
      "company": "Google inc.",
      "country": "US",
      "id": "ad_EQzGqWoY",
      "name": "John Smith",
      "phone": "5556251199",
      "plus_code": "PQ7W+WM",
      "province": "KY",
      "zip": "40202"
    },
    "billing_address_short_id": "ar_EQzGqWoY",
    "currency": "USD",
    "custom_items": [
      {
        "grams": 200,
        "height": 150,
        "inventory_location_id": "",
        "length": 150,
        "physical": true,
        "price": 5,
        "tax_class": "",
        "taxable": true,
        "title": "",
        "width": 150
      }
    ],
    "customer_email": "Customer email, used in no auth order flows",
    "customer_id": "cu_EQzGqWoY",
    "discount_code": "AD1241251",
    "gateway_id": "gw_EQzGqWoY",
    "line_items": [
      {
        "custom_item_index": {
          "value": 5
        },
        "field_set_id": "",
        "fields": [
          {
            "choice_index": 5,
            "field_index": 5,
            "label": "",
            "type": "checkbox",
            "value": ""
          }
        ],
        "quantity": 0,
        "subscription_plan_index": {
          "value": 5
        },
        "variant_id": "va_EQzGqWoY"
      }
    ],
    "mobile": "45634634562",
    "mobile_notifications": false,
    "sales_channel_id": "sc_EQzGqWoY",
    "send_fulfillment_notifications": false,
    "send_order_notifications": false,
    "shipping_address_short_id": "ar_EQzGqWoY",
    "shipping_rate_ids": [
      ""
    ],
    "subscription_id": "ss_EQzGqWoY",
    "tags": [
      ""
    ]
  }
]

Response Body

Array of Order

Response Body Type

Loading module