Getting information about a single shipment

Info

Console

The method is available for the FBS model.

If you are using an API Key token, one of the accesses in the list is required to call the method

inventory-and-order-processing — Order processing and inventory
inventory-and-order-processing:read-only — View order information
all-methods — Full account management
all-methods:read-only — View all data

Returns information about the shipment by its identifier.

, Limit: 100 requests per hour

Request

GET

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page:

Modules and APIs → block Sending data to Yandex.Market.
Query log → drop-down list in the block Show logs.

Do not send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports.

Min value: 1

shipmentId*

Type: integer<int64>

Shipment ID.

Min value: 1

Query parameters

Name

Description

cancelledOrders

Type: boolean

Whether to refund cancelled orders.

Default value: true. If you do not need to refund cancelled orders, pass the value false.

Default: true

Responses

200 OK

The found shipment.

Body

application/json

{
    "status": "OK",
    "result": {
        "id": 0,
        "planIntervalFrom": "2017-11-21T00:00:00+03:00",
        "planIntervalTo": "2017-11-21T00:00:00+03:00",
        "shipmentType": "IMPORT",
        "warehouse": {
            "id": 0,
            "name": "string",
            "address": "string"
        },
        "warehouseTo": {
            "id": 0,
            "name": "string",
            "address": "string"
        },
        "externalId": "string",
        "deliveryService": {
            "id": 0,
            "name": "string"
        },
        "palletsCount": {
            "planned": 0,
            "fact": 0
        },
        "orderIds": [
            0
        ],
        "draftCount": 0,
        "plannedCount": 0,
        "factCount": 0,
        "signature": {
            "signed": false
        },
        "currentStatus": {
            "status": "OUTBOUND_CREATED",
            "description": "string",
            "updateTime": "2017-11-21T00:00:00+03:00"
        },
        "availableActions": [
            "CONFIRM"
        ]
    }
}

Name

Description

result

Type: ShipmentDTO

Shipping information.
Shipping information.
Shipping information.

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ShipmentDTO

Shipping information.

Name	Description
availableActions*	Type: ShipmentActionType[] Available actions on the shipment. Shipping actions: `CONFIRM` — confirm the shipment. `DOWNLOAD_ACT` — download the shipment acceptance and transfer certificate. `DOWNLOAD_INBOUND_ACT` — download the list of accepted orders. `DOWNLOAD_DISCREPANCY_ACT` — download the act of discrepancies. `DOWNLOAD_TRANSPORTATION_WAYBILL` — download the bill of lading. `CHANGE_PALLETS_COUNT` — specify the number of pallets. Enum: `CONFIRM`, `DOWNLOAD_ACT`, `DOWNLOAD_INBOUND_ACT`, `DOWNLOAD_DISCREPANCY_ACT`, `DOWNLOAD_TRANSPORTATION_WAYBILL`, `CHANGE_PALLETS_COUNT` Unique items
draftCount*	Type: integer<int32> The number of orders that the Market has scheduled for shipment. Min value: `0`
factCount*	Type: integer<int32> The number of orders accepted at the sorting center or reception point. Min value: `0`
id*	Type: integer<int64> Shipment ID. Min value: `1`
orderIds*	Type: integer<int64>[] The IDs of the orders in the shipment. Min value: `1` Unique items
planIntervalFrom*	Type: string<date-time> The beginning of the scheduled shipping interval. Date format: ISO 8601 with an offset relative to UTC. Example: `2017-11-21T00:00:00+03:00`
planIntervalTo*	Type: string<date-time> The end of the planned shipping interval. Date format: ISO 8601 with an offset relative to UTC. Example: `2017-11-21T00:00:00+03:00`
plannedCount*	Type: integer<int32> The number of orders that the Market has confirmed for shipment. Min value: `0`
signature*	Type: [SignatureDTO(#signaturedto) Information about the signature of the acceptance certificate.
currentStatus	Type: ShipmentStatusChangeDTO Shipment status.
deliveryService	Type: DeliveryServiceDTO The delivery service.
externalId	Type: string The shipment ID in your system. If you haven't passed the ID yet, the ID from the parameter will be returned. `id`.
palletsCount	Type: PalletsCountDTO Information about the pallets in the shipment.
shipmentType	Type: ShipmentType The method of shipping orders. Enum: `IMPORT`, `WITHDRAW`
warehouse	Type: PartnerShipmentWarehouseDTO Information about the shipping warehouse.
warehouseTo	Type: PartnerShipmentWarehouseDTO Information about the destination warehouse.

ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

ShipmentActionType

Shipping actions:

CONFIRM — confirm the shipment.
DOWNLOAD_ACT — download the shipment acceptance and transfer certificate.
DOWNLOAD_INBOUND_ACT — download the list of accepted orders.
DOWNLOAD_DISCREPANCY_ACT — download the act of discrepancies.
DOWNLOAD_TRANSPORTATION_WAYBILL — download the bill of lading.
CHANGE_PALLETS_COUNT — specify the number of pallets.

Type	Description
ShipmentActionType	Enum: `CONFIRM`, `DOWNLOAD_ACT`, `DOWNLOAD_INBOUND_ACT`, `DOWNLOAD_DISCREPANCY_ACT`, `DOWNLOAD_TRANSPORTATION_WAYBILL`, `CHANGE_PALLETS_COUNT`

SignatureDTO

Information about the signature of the acceptance certificate.

Name

Description

signed*

Type: boolean

Has the acceptance certificate been signed?

ShipmentStatusChangeDTO

Shipment status.

Name	Description
description	Type: string Description of the shipment status.
status	Type: ShipmentStatusType Shipment status. Enum: `OUTBOUND_CREATED`, `OUTBOUND_READY_FOR_CONFIRMATION`, `OUTBOUND_CONFIRMED`, `OUTBOUND_SIGNED`, `FINISHED`, `ACCEPTED`, `ACCEPTED_WITH_DISCREPANCIES`, `ERROR`
updateTime	Type: string<date-time> The time of the last change in the shipment status. Date format: ISO 8601 with an offset relative to UTC. Example: `2017-11-21T00:00:00+03:00`

DeliveryServiceDTO

The delivery service.

Name

Description

Type: integer<int64>

The delivery service ID.

name

Type: string

The name of the delivery service.

PalletsCountDTO

The number of pallets in the shipment.

Name

Description

fact

Type: integer<int32>

The number of pallets accepted at the sorting center.

Min value: 0

planned

Type: integer<int32>

The number of pallets specified by the seller.

Min value: 0

ShipmentType

Shipping method of orders:

IMPORT — you bring your orders to the selected sorting center or order acceptance point on your own.
WITHDRAW — you ship orders from your warehouse to Yandex Market couriers.

Type	Description
ShipmentType	Enum: `IMPORT`, `WITHDRAW`

PartnerShipmentWarehouseDTO

Information about the shipping warehouse.

Name	Description
id*	Type: integer<int64> The ID of the shipping warehouse. Min value: `1`
address	Type: string The address of the shipping warehouse.
name	Type: string The name of the shipping warehouse.

ShipmentStatusType

Shipment status:

OUTBOUND_CREATED — it is being formed.
OUTBOUND_READY_FOR_CONFIRMATION — it can be processed.
OUTBOUND_CONFIRMED — confirmed and ready to ship.
OUTBOUND_SIGNED — an electronic acceptance certificate has been signed for it.
ACCEPTED — accepted at the sorting center or reception point.
ACCEPTED_WITH_DISCREPANCIES — accepted with discrepancies.
FINISHED — completed.
ERROR — cancelled due to an error.

Type	Description
ShipmentStatusType	Enum: `OUTBOUND_CREATED`, `OUTBOUND_READY_FOR_CONFIRMATION`, `OUTBOUND_CONFIRMED`, `OUTBOUND_SIGNED`, `FINISHED`, `ACCEPTED`, `ACCEPTED_WITH_DISCREPANCIES`, `ERROR`

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

The requested resource was not found. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error in Yandex. Market. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Transferring orders to the next shipment

Information about multiple shipments