Обновление информации о PO в заказе

Метод используется для обновления информации о заказе из системы закупок клиента (Purchase Order, PO) в заказе аккаунта, к которому есть доступ у текущего пользователя. Некоторые вендоры могут требовать номер заказа в системе закупок клиента и его файл для подтверждения покупки. Метод может использоваться с заказами любого типа и в любом статусе.

Первоначально заказ наследует информацию о PO из корзины покупок (см. Обновление информации о PO в корзине покупок).

Метод возвращает информацию о PO в заказе.

PATCH {reseller_domain}/internal_api/accounts/{account_id}/orders/{order_id}/update_po_data

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название		Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type		header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept		header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale		header	string	Опциональный	Двухбуквенный код языка данных в ответе и созданной асинхронной задачи
Authorization		header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain		path	string	Обязательный	Доменное имя реселлера
account_id		path	integer	Обязательный	ID аккаунта
order_id		path	integer	Обязательный	ID заказа
po_number		form	string	Опциональный	Номер заказа в системе закупок клиента (до 100 символов). Чтобы удалить номер заказа из корзины покупок, укажите null
po_document		form	object	Опциональный	Информация о файле заказа из системы закупок клиента. Чтобы удалить файл заказа из корзины покупок, укажите null
	name	form	string	Опциональный	Имя файла
	data	form	string	Опциональный	Файл в кодировке base64 (до 2 МБ). Поддерживаются следующие форматы: .pdf, .doc, .docx, .xls, .xlsx, .ppt, .pptx, .txt, .csv, .bmp, .gif, .jpg, .jpeg, .png

Модель ответа

Название				Тип данных	Описание
data				object	Данные ответа
	id			string	ID заказа
	type			string	Тип данных
	attributes			object	Информация о заказе в системе закупок клиента (Purchase Order, PO)
		po_number		string	Номер заказа в системе закупок клиента
		po_document		object	Информация о файле заказа из системе закупок клиента
			name	string	Имя файла
			url	string	Ссылка на файл
			size	integer	Размер файла в байтах
meta				object	Дополнительная информация
	server_current_time			string	Текущие дата и время сервера

Пример запроса

Bash

curl --location --request PATCH 'https://test.activeplatform.com/internal_api/accounts/2091/orders/19393/update_po_data' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data-raw '{
  "data": {
    "attributes": {
      "po_number": "00230508",
      "po_document": {
        "name": "PO_signed",
        "data": "data:application/pdf;base64,XXX"
      }
    }
  }
}'

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

JSON

{
    "data": {
        "id": "19393",
        "type": "orders",
        "attributes": {
            "po_number": "00230508",
            "po_document": {
                "name": "PO_signed.pdf",
                "url": "https://storage.test.activeplatform.com/private/uploads/sales_order/po_document/19393/PO_signed.pdf?expires=1699722165\u0026hash=iuM",
                "size": 294186
            }
        }
    },
    "meta": {
        "server_current_time": "2023-11-11T19:59:45.648302+0300"
    }
}