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:* строка
Текстовый идентификатор объекта в хранилище заказов
пример: my-order

id:* число
ID объекта заказа
пример: 1

data:* IOrderData
Объект для обновления заказа
пример:

langCode: строка
Необязательное поле языка
пример: en_US

Схема (тело)

formIdentifier: строка
текстовый идентификатор объекта формы, связанного с хранилищем заказов
пример: bars

paymentAccountIdentifier: строка
текстовый идентификатор объекта платежа, связанного с хранилищем заказов
пример: payment1

statusIdentifier строка
текстовый идентификатор объекта статуса заказа (если не указано, будет назначен статус по умолчанию)
пример: inprogress

formData FormDataType
данные, отправленные формой, связанной с хранилищем заказов
пример:

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

products Record<string, string | any>[]
массив продуктов, добавленных в заказ

productId число
идентификатор продукта
пример: 12.00

quantity число
количество продукта
пример: 1

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

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

{
  "formIdentifier": "bars",
  "paymentAccountIdentifier": "payment1",
  "statusIdentifier": "inprogress",
  "formData": [
      {
        "marker": "marker_1",
        "type": "string",
        "value": "Name"
      }
  ],
  "products": [
    {
      "productId": 1,
      "quantity": 2
    },
    {
      "productId": 2,
      "quantity": 3
    }
  ],
  "createdDate": "2024-06-21T09:42:54.848Z",
  "currency": "USD",
  "totalSum": 345
}

Схема

statusIdentifier: строка
текстовый идентификатор статуса заказа
пример: inprogress

formIdentifier: строка
текстовый идентификатор статуса формы
пример: order-form

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

formData FormDataType
данные, отправленные формой, связанной с хранилищем заказов
пример:

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

products Record<string, string | any>[]
массив продуктов, добавленных в заказ

totalSum строка
общая сумма заказа
пример: 12.00

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

createdDate строка
дата создания заказа
пример: 2023-01-01 12:12