Управлять листами передачи (FBS LAliExpress)

Параметр	Тип	Обязательный	Описание
logistic_order_ids	array of integers	Да	Список идентификаторов отправлений, значение поля orders.logistic_orders.id из ответа метода POST /seller-api/v1/logistic-order/create.
arrival_date	string	Нет	Дата передачи отправлений в формате YYYY-MM-DDT00:00:00.000Z.

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/seller-api/v1/handover-list/create' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data-raw '{
    "logistic_order_ids": [
        1118070
    ],
    "arrival_date": "2022-09-20T00:00:00.000Z"
}'

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

Параметр	Тип	Описание
error	object	Ошибки при создании листа передачи.
↳ code	string	Код ошибки, возможные значения: HeaderNotFound — Отсутствует параметр seller_id в заголовке. InvalidCutoff — Некорректная дата отправки отправлений. MultipleProvidersError — Разные провайдеры у логистических заказов. MultipleFirstMileProvidersError — Разные провайдеры у логистических заказов. OrdersNotFbs — В листе передачи присутствуют отправления с другим типом первйо мили (FBA). OrdersIncorrectStatusError — Некорректный статус отправлений. OrdersIncorrectAddressError — Некорректный адрес на отправлениях. OrdersWithoutExternalIdError — Отсутствует внешний идентификатор у отправлений. RupostError — Ошибка Почты России.
↳ message	string	Сообщение об ошибке.
↳ details	object	Дополнительная информация по ошибке.
data	object	Информация по запросу.
↳ handover_list_id	int	Идентификатор листа передачи.

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

{
  "data": {
    "handover_list_id": 105964
  },
  "error": null
}

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

POST /seller-api/v1/handover-list/get-by-filter

Возвращает список листов передачи, поддерживает фильтрацию.

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

Параметр	Тип	Обязательный	Описание
statuses	[string]	Нет	Фильтр по статусу листа передачи, может принимать значения: Created — Создан, Transferred — Передан, Accepted — Принят, PartiallyAccepted — Частично принят, Sent — Отправлен, Completed — Завершён.
handover_list_ids	int	Нет	Фильтр по идентификаторам листов передачи, значение поля handover_list_ids из ответа метода POST /seller-api/v1/handover-list/create.
logistic_order_ids	array of integers	Нет	Фильтр по идентификаторам отправлений.
gmt_create_from	string	Нет	Фильтр по листам передачи с датой создания после этой даты, формат: YYYY-MM-DDThh:mm:ssZ.
gmt_create_to	string	Нет	Фильтр по листам передачи с датой создания не позднее этой даты, формат: YYYY-MM-DDThh:mm:ssZ.
arrival_date_sort	string	Нет	Сортировка по времени прибытия листа передачи, может принимать значения: ASC (по возрастанию), DESC (по убыванию), NONE (не сортирует).
gmt_create_sort	string	Нет	Сортировка по времени создания листа передачи, может принимать значения: ASC (по возрастанию), DESC (по убыванию), NONE (не сортирует).
page_size	int	Да	Число страниц, которые нужно вывести.
page_number	int	Да	Номер страницы из списка, которую необходимо вывести.

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

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

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

Параметр	Тип	Описание
error	object	Ошибки при создании PDF-файла листа передачи.
↳ code	string	Код ошибки, возможные значения: HeaderNotFound - Отсутствует параметр seller_id в заголовке.
↳ message	string	Сообщение об ошибке.
↳ details	object	Дополнительная информация по ошибке.
data	object	Информация по запросу.
↳ data_source	object	Информация по листу передачи.
↳ handover_list_id	int	Идентификатор листа передачи.
↳ arrival_date	int	Дата прибытия листа передачи.
↳ status	string	Статус листа передачи, возможные значения: Created — Создан, Transferred — Передан, Accepted — Принят, PartiallyAccepted — Частично принят, Sent — Отправлен, Completed — Завершён.
↳ shipment_type	string	Тип листа передачи, возможные значения: Pickup, Dropoff.
↳ logistic_order_ids	array of integers	Идентификаторы отправлений.
↳ gmt_create	array of integers	Дата создания листа передачи.
page_info	object	Информация о страницах списка.
↳ current	int	Номер текущей страницы в списке.
↳ page_size	int	Количество страниц в списке.
↳ total	int	Количество листов передачи, удовлетворяющих фильтру.

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

{
    "data": {
        "data_source": [
            {
                "handover_list_id": 10106,
                "arrival_date": "2021-12-30T05:00:00Z",
                "status": "Created",
                "shipment_type": "Dropoff",
                "logistic_order_ids": [
                    88236
                ],
                "gmt_create": "2021-05-28T16:36:21Z"
            },
            {
                "handover_list_id": 40494,
                "arrival_date": "2021-07-15T18:34:07Z",
                "status": "Transferred",
                "shipment_type": "Dropoff",
                "logistic_order_ids": [
                    309784
                ],
                "gmt_create": "2021-07-12T22:05:07Z"
            }
        ],
        "page_info": {
            "current": 1,
            "page_size": 2,
            "total": 2
        }
    },
    "error": null
}

Добавить отправление в лист передачи

POST /seller-api/v1/handover-list/add-logistic-orders

Добавляет указанное отправление в лист передачи.

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

Параметр	Тип	Обязательный	Описание
handover_list_id	int	Да	Идентификатор листа передачи, значение поля handover_list_ids из ответа метода POST /seller-api/v1/handover-list/create или метода POST /seller-api/v1/handover-list/get-by-filter.
order_ids	array of integers	Да	Список идентификаторов отправлениий, значение поля из ответа метода POST /seller-api/v1/logistic-order/get.

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/seller-api/v1/handover-list/add-logistic-orders' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <YOUR_API_TOKEN>' \
--data-raw '{
    "handover_list_id": 103802,
    "order_ids": [
        1113742
    ]
}'

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

Параметр	Тип	Описание
error	object	Ошибки при добавлении отправления в лист передачи.
↳ code	string	Код ошибки, возможные значения: HeaderNotFound — Отсутствует параметр seller_id в заголовке. OrdersNotFbs — Отправления имеют неверный тип доставки. SellerMismatch — Продавец в шапке запроса отличается от продавца в листе передачи. WrongHandoverListStatusError — Некорректный статус листа передачи. ProvidersMismatch — Провайдер первой мили в отправлении отличается от провайдера в листе передачи. OrdersWithoutExternalIdError — У отправлений не указан внешний идентификатор. InvalidCutoff — Некорректная дата отправки отправлений. MultipleProvidersError — Разные провайдеры у логистических заказов. MultipleFirstMileProvidersError — У отправлений отличаются провайдеры первой мили. HandoverListNotFound — Лист передачи не найден. OrdersIncorrectStatusError — Некорректный статус отправлений. RupostError — Ошибка Почты России.
↳ message	string	Сообщение об ошибке.
↳ details	object	Дополнительная информация по ошибке.
data	object	Информация по запросу.

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

{
    "error": {
        "code": "SellerMismatch",
        "message": "Продавец отличается от продавца в листе передачи",
        "details": null
    },
    "data": null
}

Напечатать лист передачи

POST /seller-api/v1/labels/handover-lists/get

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

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

Параметр	Тип	Обязательный	Описание
handover_list_id	int	Да	Идентификатор листа передачи.

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

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

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

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

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

{
    "error": {
        "code": "DifferentOwner",
        "message": "Отправления принадлежат другому продавцу",
        "details": null
    },
    "data": null
}

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

POST /seller-api/v1/handover-list/remove-logistic-orders

Удаляет указанные отправления из листа передачи.

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

Параметр	Тип	Обязательный	Описание
handover_list_id	int	Да	Идентификатор листа передачи, значение поля handover_list_id из ответа метода POST /seller-api/v1/handover-list/create или метода POST /seller-api/v1/handover-list/get-by-filter.
order_ids	array of integers	Да	Идентификаторы отправлений, значение поля logistic_orders.logistic_order_id из ответа метода POST /seller-api/v1/logistic-order/get.

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

curl -X 'POST' \
  'https://openapi.ru.laliexpress.com/seller-api/v1/handover-list/remove-logistic-orders' \
  -H 'accept: text/plain' \
  -H 'x-auth-token: <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "handover_list_id": 103262,
  "order_ids": [
    "1112555"
  ]
}'

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

Параметр	Тип	Описание
error	object	Ошибки при удалении отправления из листа передачи.
↳ code	string	Код ошибки, возможные значения: HeaderNotFound — Отсутствует параметр seller_id в заголовке. HandoverListNotFound — Лист передачи не найден. SellerMismatch — Некорректный продавец. InvalidHandoverList — Некорректный лист передачи. WrongHandoverListStatusError — Некорректный статус листа передачи. OrdersIncorrectStatusError — Некорректный статус заказов. OrdersWithoutExternalIdError — Отсутствует внешний идентификатор у заказа. RupostError — Ошибка Почты России.
↳ message	string	Сообщение об ошибке.
↳ details	object	Дополнительная информация по ошибке.
data	object	Информация по запросу.

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

{
    "error": {
        "code": "SellerMismatch",
        "message": "Некорректный продавец.",
        "details": null
    },
    "data": null
}

Закрыть лист передачи

POST /seller-api/v1/handover-list/transfer

Переводит лист передачи в статус Transfered (передан).

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

Параметр	Тип	Обязательный	Описание
handover_list_id	int	Да	Идентификатор листа передачи.

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

curl --location --request POST 'https://openapi.ru.laliexpress.com/seller-api/v1/handover-list/transfer' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--header 'x-auth-token: <your_api_token>' \
--data-raw '{
  "handover_list_id": 103277
}'

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

Параметр	Тип	Описание
error	object	Ошибки при изменении статуса листа передачи.
↳ code	string	Код ошибки, возможные значения: HeaderNotFound — Отсутствует параметр seller_id в заголовке. HandoverListNotFound — Лист передачи не найден. SellerMismatch — Некорректный продавец. InvalidHandoverList — Некорректный лист передачи.
↳ message	string	Сообщение об ошибке.
↳ details	object	Дополнительная информация по ошибке.
data	object	Информация по запросу.

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

{
    "error": {
        "code": "SellerMismatch",
        "message": "Некорректный продавец",
        "details": null
    },
    "data": null
}

Продавцам

Полезное

Партнёрская программа

Контакты

Канал в Telegram

ВКонтакте

Новости и общение

Войти

Общая информация

Справочник методов API

Оглавление

Создать лист передачи

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

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

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

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

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

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

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

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

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

Добавить отправление в лист передачи

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

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

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

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

Напечатать лист передачи

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

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

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

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

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

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

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

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

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

Закрыть лист передачи

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

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

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

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