updateOrderByMarkerAndId

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

Описание

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

Orders.updateOrderByMarkerAndId(

marker, id, body, body.formIdentifier, body.paymentAccountIdentifier, body.formData, formData.marker, formData.type, formData.value, body.products, langCode

);

Схема параметров

Схема

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

id(обязательно): number
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"
}

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

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

body.formData(обязательно): IOrdersFormData | IOrdersFormData[]
Данные формы, связанные с репозиторием заказов.
пример:

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

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

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

formData.value(обязательно): string
Значение.
пример: "Name"

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

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

Примеры

Минимальный пример

const body = {
"formIdentifier": "orderForm",
"paymentAccountIdentifier": "cash",
"formData": {
{
"marker": "order_name",
"type": "string",
"value": "Ivan"
}
},
"products": [
{
"productId": 2,
"quantity": 2
}
]
};
const response = await Orders.updateOrderByMarkerAndId("my-order", 1, body);

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

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

Схема ответа

Схема: IBaseOrdersEntity

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

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

paymentAccountIdentifier: string
Текстовый идентификатор платежа по заказу.
пример: "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
  }
]

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

totalSum: number
Общая сумма заказа.
пример: NaN

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

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

---