updateOrderByMarkerAndId

Изменение заказа в хранилище заказов 🔐 Этот метод требует авторизации.

Orders.updateOrderByMarkerAndId(marker, body, langCode)

const body = {
  "formIdentifier": "orderForm",
  "paymentAccountIdentifier": "cash",
  "formData": {
    "marker": "order_name",
    "value": "Ivan",
    "type": "string"
  },
  "products": [
    {
      "productId": 2,
      "quantity": 2
    }
  ]
}

const value = await Orders.updateOrderByMarkerAndId('my-order', 1, body)

Схема

marker(обязательный): строка
Текстовый идентификатор объекта в хранилище заказов
пример: "order_storage_1"

id(обязательный): число
ID объекта заказа
пример: 12345

body(обязательный): IOrderData
Объект для обновления заказа
пример:

{
  "formIdentifier": "bar-orders-form",
  "paymentAccountIdentifier": "usd-payment",
  "formData": {
    "marker": "name_1",
    "value": "Name",
    "type": "string"
  },
  "products": [
    {
      "productId": 1,
      "quantity": 2
    }
  ],
  "currency": "USD"
}

formIdentifier(обязательный): строка
Текстовый идентификатор объекта формы, связанного с хранилищем заказов.
пример: "bar-orders-form"

paymentAccountIdentifier(обязательный): строка
Текстовый идентификатор объекта платежа, связанного с хранилищем заказов.
пример: "payment-1"

formData(обязательный): IOrdersFormData
Данные формы, связанные с хранилищем заказов.
пример:

[
  {
    "marker": "name_1",
    "value": "Name",
    "type": "string"
  }
]

marker(обязательный): строка
Маркер поля формы.
пример: "name_1"

value(обязательный): строка
Значение.
пример: "Name"

type(обязательный): строка
Тип значения.
пример: "string"

products(обязательный): IOrderProductData[]
Массив заказанных продуктов.

langCode: строка
Код языка. По умолчанию: "en_US"
пример: "en_US"

Этот метод обновляет один объект хранилища заказов по маркеру. Метод добавит язык по умолчанию в тело запроса. Если вы хотите изменить язык, просто передайте его вторым аргументом.

Пример возврата:

{
  "id": 55,
  "formIdentifier": "orderForm",
  "paymentAccountIdentifier": "cash",
  "formData": [
    {
      "marker": "order_name",
      "value": "Ivan",
      "type": "string"
    }
  ],
  "products": [
    {
      "productId": 2957,
      "quantity": 2
    }
  ],
  "currency": "",
  "totalSum": 300
}

Схема

id: число
Идентификатор объекта.
пример: 1

formIdentifier: строка
Текстовый идентификатор статуса формы.
пример: "bar-orders-form"

paymentAccountIdentifier: строка
Текстовый идентификатор платежа заказа.
пример: "payment-1"

formData: IOrdersFormData[]
Данные, отправленные формой, связанной с хранилищем заказов.
пример:

[
  {
    "marker": "name_1",
    "value": "Name",
    "type": "string"
  }
]

products: IOrderProducts[]
Массив продуктов, добавленных в заказ.
пример:

[
  {
    "id": 2957,
    "title": "Cosmo",
    "sku": null,
    "previewImage": null,
    "price": 150,
    "quantity": 2
  }
]

createdDate: строка
Дата создания заказа.
пример: "2023-10-01T12:00:00Z"

totalSum: строка
Общая сумма заказа.
пример: "99.99"

currency: строка
Валюта, использованная для оплаты заказа.
пример: "USD"

statusIdentifier: строка
Текстовый идентификатор объекта статуса заказа (если не установлен, будет назначен статус по умолчанию).
пример: "status-1". /

---