Полное обновление состава отгрузки

POST /v1/shipment/update

POST/v1/shipment/update

Допустимый статус отгрузки: только DRAFT.

Тело запроса

shipment_id

string

required

Идентификатор отгрузки.

shipment_date

string

Дата отгрузки в формате YYYY-MM-DD.

packages

array

required

Полный список грузомест (PUT-замена). Только существующие package_id этой отгрузки; пустой массив удаляет все грузоместа. Коды ошибок — description метода shipment/update.

ordersFbsShipmentPackageItem

Показать свойства

ordersFbsShipmentPackageItem

package_id

string

required

Идентификатор существующего грузоместа отгрузки (обязателен для shipment/update).

package_number

integer

required

Порядковый номер грузоместа.

type

string

required

Тип грузоместа.

Допустимые значения

BOXPALLET

merchant_order_ids

array

required

Идентификаторы заказов в грузоместе.

Успешный ответ

200A successful response.

application/json

object

packages

array

required

Сохранённые грузоместа.

ordersFbsShipmentUpdateResponsePackageItem

Показать свойства

ordersFbsShipmentUpdateResponsePackageItem

package_id

string

required

Идентификатор грузоместа.

package_number

integer

required

Порядковый номер грузоместа.

type

string

required

BOX — короб; PALLET — паллета.

Допустимые значения

BOXPALLET

merchant_order_ids

array

required

Идентификаторы заказов в грузоместе.

Ошибки

400Некорректный запрос

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

код ошибки

message

string

сообщение

details

object

401Ошибка авторизации

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

код ошибки

message

string

сообщение

details

object

429Превышен лимит запросов

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

код ошибки

message

string

сообщение

details

object

500Внутренняя ошибка сервера

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

код ошибки

message

string

сообщение

details

object

defaultОшибка (неожиданная или прочие)

application/json

object

error_type

string

ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500

Допустимые значения

ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL

code

string

код ошибки

message

string

сообщение

details

object

POST/v1/shipment/update

1curl https://api.omninet.ru/v1/shipment/update \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "shipment_id": "string",6  "shipment_date": "string",7  "packages": [8    {9      "package_id": "string",10      "package_number": 0,11      "type": "string",12      "merchant_order_ids": [13        "string"14      ]15    }16  ]17}'

{
  "packages": [
    {
      "package_id": "string",
      "package_number": 0,
      "type": "string",
      "merchant_order_ids": [
        "string"
      ]
    }
  ]
}

A successful response.