Getting information about a single shipment

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

Returns information about the shipment by its identifier.

⚙️ Limit: 100 requests per hour

Request

GET

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The store's campaign ID.

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market — click on your account icon → Settings and in the menu on the left, select APIs and modules:

  • block Campaign ID;
  • tab Query log → drop-down list in the block Show logs.

⚠️ It does not match the store's ID (which is indicated in the merchant's account on the Market next to the store's name and in some reports). It is linked to the store one-to-one. Does not apply to advertising campaigns.

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

status*

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

result
Type: object

availableActions*

Type: string[]

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[]

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: object

signed*

Type: boolean

Has the acceptance certificate been signed?

Information about the signature of the acceptance certificate.

currentStatus
Type: object

description

Type: string

Description of the shipment status.

status

Type: string

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.

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

Shipment status.

deliveryService
Type: object

id

Type: integer<int64>

The delivery service ID.

name

Type: string

The name of the delivery service.

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: object

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

The number of pallets in the shipment.

shipmentType

Type: string

Shipping method of orders:

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

Enum: IMPORT, WITHDRAW

warehouse
Type: object

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.

Information about the shipping warehouse.

warehouseTo
Type: object

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.

Information about the shipping warehouse.

Information about the shipment.
Information about the shipment.
Information about the shipment.

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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of the Market. More information about the error

Body

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

  • OK — There are no errors.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.

Previous
Information about documents
Next
Information about multiple shipments