Получение акта приема-передачи

Метод доступен для модели FBS.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Экспресс‑доставка

Если ваш магазин подключен к экспресс‑доставке и вы отгружаете заказы курьерам Яндекс Go, подготавливать акт приема‑передачи не нужно.

Запрос формирует акт приема-передачи заказов, входящих в отгрузку, и возвращает акт в формате PDF. В акте содержатся собранные и готовые к отправке заказы.

При формировании акта Маркет автоматически находит и подставляет в шаблон следующие данные:

Данные, из которых Маркет формирует акт

Данные в акте

Описание

Дата

Дата запроса.

Отправитель

Название вашего юридического лица, указанное в кабинете продавца на Маркете.

Исполнитель

Название юридического лица сортировочного центра или службы доставки.

№ отправления в системе заказчика

Поле больше не используется

Ваш идентификатор заказа, который вы указали в ответе на запрос POST order/accept от Маркета.

№ отправления в системе исполнителя (субподрядчика)

Идентификатор заказа на Маркете, как в выходных данных запроса GET campaigns/{campaignId}/orders.

Объявленная ценность

Общая сумма заказа без учета стоимости доставки, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}.

Вес

Масса брутто грузового места (суммарная масса упаковки и содержимого), как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}.

Количество мест

Количество грузовых мест в заказе, как в выходных данных запроса GET campaigns/{campaignId}/orders или GET campaigns/{campaignId}/orders/{orderId}.

Остальные поля нужно заполнить самостоятельно в распечатанном акте.

⚙️ Лимит: 100 запросов в час

Request

GET

https://api.partner.market.yandex.ru/campaigns/{campaignId}/first-mile/shipments/{shipmentId}/act

Path parameters

Name

Description

campaignId*

Type: integer<int64>

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

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

shipmentId*

Type: integer<int64>

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

Min value: 1

Responses

200 OK

Акт приема-передачи для отгрузки в формате PDF.

Body

application/pdf

Type: string

Format: binary

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

401 Unauthorized

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR