Управлять отправлениями (FBS LAliExpress)

Создаёт отправления для локальных заказов. Предсплитованные отправления из заказа (поле pre_split_postings из ответа метода получения списка заказов) можно разделять, но нельзя объединять. Количество товаров в отправлении должно быть не больше, чем есть в предсплитованном отправлении.

Параметры запроса

Параметр	Тип	Обязательный	Описание
orders	array of objects	Да	Список заказов.
↳ trade_order_id	int	Да	Идентификатор заказа, значение поля orders.id из ответа метода получения списка заказов.
↳ total_length	int	Да	Длина посылки (см).
↳ total_width	int	Да	Ширина посылки (см).
↳ total_height	int	Да	Высота посылки (см).
↳ total_weight	double	Да	Вес посылки (кг).
↳ items	int	Да	Список товаров в отправлении.
↳ quantity	int	Да	Количество единиц вариации товара в отправлении, значение поля orders.orders_lines.quantity из ответа метода получения списка заказов.
↳ sku_id	int	Да	Идентификатор вариации товара, значение поля orders.orders_lines.sku_id из ответа метода получения списка заказов.
↳ product_source_id	int	Нет	Идентификатор источника товара. По умолчанию: 0. Значение product_source_id из ответа метода POST /seller-api/v1/order/get-order-list.

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/seller-api/v1/logistic-order/create' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data-raw '{
    "orders": [
        {
            "trade_order_id": 2207197727599807,
            "total_length": 20,
            "total_width": 10,
            "total_height": 5,
            "total_weight": 1.5,
            "items": [
                {
                    "quantity": 1,
                    "sku_id": 12000027037707016
                }
            ]
        }
    ]
}'

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

Параметр	Тип	Описание
data	object	Результат запроса.
↳ orders	array of objects	Список заказов.
↳ trade_order_id	int	Идентификатор заказа.
↳ logistic_orders	array of objects	Список отправлений.
↳ id	int	Идентификатор отправления.
↳ lines	array of objects	Список товаров в отправлении.
↳ sku_id	int	Идентификатор вариации товара.
↳ quantity	int	Количество единиц этой вариации товара в отправлении.
↳ product_source_id	int	Идентификатор источника товара.
error	object	Ошибки при создании отправления.
↳ code	string	Код ошибки:
↳ message	string	Сообщение об ошибке.
↳ details	object	Дополнительная информация по ошибке.

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

{
  "data": {
    "orders": [
      {
        "trade_order_id": 2212196848241455,
        "logistic_orders": [
          {
            "id": 9804616,
            "lines": [
              {
                "sku_id": 12000026559024132,
                "product_source_id": 0,
                "quantity": 3
              }
            ]
          }
        ]
      }
    ]
}
}

Пример ответа с ошибкой

{
    "data": {
        "orders": [],
        "errors": {
            "common_errors": [
                {
                    "code": "NoTradeOrderFound",
                    "message": "Заказ не найден"
                }
            ],
            "item_errors": null
        }
    },
    "error": null
}

Получить список отправлений

POST /seller-api/v1/logistic-order/get

Возвращает список отправлений в соответствии с заданным фильтром.

Параметры запроса

Параметр	Тип	Обязательный	Описание
logistic_order_ids	array of integers	Нет	Список идентификаторов отправлений, значение поля orders.logistic_orders.id из ответа метода создания отправления.
tracking_numbers	array of strings	Нет	Номера отслеживаний.
trade_order_ids	array of integers	Нет	Идентификаторы заказов.
filter_status	string	Нет	Фильтр по статусу отправлений, может принимать значения: NEW (Отправление создается), AWAITING_ADDING_TO_HANDOVER (Ожидает добавления в лист передачи), AWAITING_REPORT_AS_SHIP (Ожидает подтверждения передачи), DELIVERING (Доставляется), DELIVERED (Доставлено), RETURNING_TO_SENDER (Возвращается), RETURNED_TO_SENDER (Возвращено), CANCELLED (Отменены), WITH_ERRORS (с ошибками).
gmt_create_from	string	Нет	Вывести в список заказы с датой создания после этой даты, формат: YYYY-MM-DDThh:mm:ssZ.
gmt_create_to	string	Нет	Вывести в список заказы с датой создания не позднее этой даты, формат: YYYY-MM-DDThh:mm:ssZ.
page_size	int	Да	Число страниц, которые нужно вывести.
page	int	Да	Номер страницы из списка, которую нужно вывести.
gmt_cut_off_date_from	string	Нет	Фильтр заказов с датой отгрузки после этой даты, формат: YYYY-MM-DDThh:mm:ssZ.
gmt_cut_off_date_to	string	Нет	Фильтр заказов с датой отгрузки не позднее этой даты, формат: YYYY-MM-DDThh:mm:ssZ.
problem_state_filter	string	Нет	Фильтр по типу ошибки, может принимать значения: Unclaimed, ExceptUnclaimed, Missed.
sort_params	object	Нет	Параметры сортировки.
↳ order_sort_type	string	Нет	Метод сортировки, может принимать значения: LogisticOrderSort (по идентификатору отправления), TradeOrderSort (по идентификатору заказа), CutOffDateSort (по дате отгрузки), CreatedAtSort (по дате создания).
↳ query_sort	string	Нет	Тип сортировки, может принимать значения: ASC (по возрастанию), DESC (по убыванию), NONE (не сортировать).
logistic_order_info	string	Нет	Флаг предоставляемой информации, может принимать значения: Common (только основная информаци), PackageItems (информация о товарах), HandoverListId (идентификатор листа передачи), StateStatusName (название статуса), BuyerName (имя покупателя), BuyerCountryCode (код страны покупателя), All (вся информация).

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/seller-api/v1/logistic-order/get' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data-raw '{
    "page_size": 1,
    "page": 1
}'

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

Параметр	Тип	Описание
error	object	Ошибка при запросе.
↳ code	string	Код ошибки, возможные значения: HeaderNotFound (Отсутствует параметр seller_id в заголовке).
↳ message	string	Сообщение об ошибке.
↳ details	object	Дополнительная информация по ошибке.
data	object	Информация по запросу.
↳ logistic_orders	array of objects	Информация по отправлениям.
↳ logistic_order_id	int	Идентификатор отправления.
↳ trade_order_id	int	Идентификатор заказа.
↳ handover_list_id	int	Идентификатор листа передачи.
↳ cut_off_date	string	Если отправление уже отгружено, указана дата отгрузки. Если отправление ещё не отгружено, указана дата, до которой его нужно отгрузить. Дата может меняться, если отгрузка переносится (не более 2 раз).
↳ status	string	Статус отправления, возможные значения: NEW (Отправление создается), AWAITING_ADDING_TO_HANDOVER (Ожидает добавления в лист передачи), AWAITING_REPORT_AS_SHIP (Ожидает подтверждения передачи), DELIVERING (Доставляется), DELIVERED (Доставлено), RETURNING_TO_SENDER (Возвращается), RETURNED_TO_SENDER (Возвращено), CANCELLED (Отменены), WITH_ERRORS (с ошибками).
↳ state_status_name	string	Название статуса.
↳ platform_tracking_code	string	Код отслеживания.
↳ items_count	int	Количество товаров.
↳ creation_error	string	Ошибка создания заказа.
↳ gmt_create	string	Дата создания заказа.
↳ trade_order_source	string	Источник заказа.
↳ total_amount	int	Сумма заказа.
↳ buyer_name	string	Имя покупателя.
↳ buyer_country_code	string	Код страны покупателя.
↳ items	object	Информация о товаре.
↳ item_id	int	Уникальный идентификатор товара.
↳ sku_id	int	Идентификатор вариации товара.
↳ name	string	Название товара.
↳ item_price	int	Цена товара.
↳ img_url	string	Ссылка на изображение товара.
↳ total_amount	int	Сумма за товар.
↳ properties	[string]	Свойства товара.
↳ mobile_url	string	Ссылка на товар в мобильном приложении.
↳ web_url	string	Ссылка на товар на сайте.
↳ quantity	int	Количество единиц этой вариации товара в отправлении.
↳ marking_required	boolean	Флаг обязательной маркировки.
↳ page_info	object	Информация по страницам созданного списка.
↳ current	int	Номер текущей страницы в списке.
↳ page_size	int	Количество страниц в списке.
↳ total	int	Количество отправлений, удовлетворяющих фильтру.

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

{
    "data": {
        "logistic_orders": [
            {
                "logistic_order_id": 88236,
                "trade_order_id": 5010627561478171,
                "handover_list_id": null,
                "cut_off_date": "2021-12-30T05:00:00+00:00",
                "status": "AWAITING_REPORT_AS_SHIP",
                "state_status_name": null,
                "platform_tracking_code": "80096960202932",
                "items_count": null,
                "creation_error": null,
                "gmt_create": "2021-05-28T16:35:10+00:00",
                "trade_order_source": "GlobalTrade",
                "total_amount": 100,
                "buyer_name": null,
                "buyer_country_code": null,
                "external_provider": null,
                "items": null
            }
        ],
        "page_info": {
            "current": 1,
            "page_size": 1,
            "total": 2
        }
    },
    "error": null
}

Напечатать этикетки для отправлений

POST /seller-api/v1/labels/orders/get

Возвращает ссылку на PDF-файл для печати этикетки отправления.

Параметры запроса

Параметр	Тип	Обязательный	Описание
logistic_order_ids	array of integers	Да	Список идентификаторов отправлений, значение поля orders.logistic_orders.id из ответа метода создания отправления.

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/seller-api/v1/labels/orders/get' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data-raw '{
    "logistic_order_ids": [
        88236
    ]
}'

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

Параметр	Тип	Описание
error	object	Ошибки при запросе.
↳ code	string	Код ошибки, возможные значения: UnsuccessfulUploadFile (Не удалось загрузить файл с этикетками в хранилище), LogisticOrdersNotFound (Отправления не найдены), LogisticProviderNotFound (Логистический провайдер не найден), LogisticOrdersHaveNotOrderExternalProvider (Отсутствует внешний идентификатор отправления), LogisticOrdersHaveNotOrderExternal (Отсутствует внешний идентификатор отправления), UnsuccessfulRuPostOrderForms (Не удалось получить этикетки в Почте России), UnknownLogisticOrderStateStatus (Отправление имеет неизвестный статус), DifferentProvidersForLogisticOrders (Логистические провайдеры в отправлениях отличаются), LogisticOrderHasNotTrackingCode (Логистические провайдеры в отправлениях отличаются), DifferentSellersForLogisticOrders (Продавцы в отправлениях отличаются), DifferentOwner (Отправления принадлежат другому продавцу).
↳ message	string	Сообщение об ошибке.
↳ details	object	Дополнительная информация по ошибке.
data	object	Информация по этикетке.
↳ label_url	string	Cсылка на PDF с этикетками для запрошенных отправлений.

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

{
  "data": {
    "label_url": "https://st.aestatic.net/providers-doc-storage/8317da5a-8961-4958-8e39-20ffb660f236"
  },
  "error": null
}

Удалить отправление

POST /seller-api/v1/logistic-order/delete

Удаляет отправления, если они не были добавлены в лист передачи.

Параметры запроса

Параметр	Тип	Обязательный	Описание
logistic_order_ids	array of integers	Да	Идентификаторы отправлений, значение поля logistic_orders.logistic_order_id из ответа метода получения списка отправлений.

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/seller-api/v1/logistic-order/delete' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data-raw '{
    "logistic_order_ids": [
        1113736
    ]
}'

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

Параметр	Тип	Описание
data	object	Информация по запросу.
↳ deletion_result_map	object	Результаты удаления.
↳ additionalProp	object	Информация по удалению отправления.
↳ deleted_at	string	Дата удаления отправления.
↳ error_message	string	Сообщение об ошибке, если удаление неуспешно.
error	object	Ошибки при удалении отправления.
↳ message	string	Сообщение об ошибке.
↳ details	object	Дополнительная информация по ошибке, возможные значения: HeaderNotFound (Отсутствует параметр seller_id в заголовке).

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

{
    "data": {
        "deletion_result_map": {
            "1113736": {
                "deleted_at": null,
                "error_message": "Failed to delete logistic order 1113736: it doesn't belong to seller 1042630114"
            }
        }
    },
    "error": null
}