Getting information about multiple shipments

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 shipments based on the specified parameters:

  • date.
  • status;
  • order IDs.

The results are returned page by page.

Limitation for the parameter limit

Do not transmit a value greater than 30.

⚙️ Limit: 100 requests per hour

Request

PUT

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.

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.

⚠️ Do not confuse it with:

  • the store's identifier, which is displayed in the merchant's personal account.
  • advertising campaigns.

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

The number of values per page.

Min value: 1
Example: 20

page_token

Type: string

ID of the results page.

If the parameter is omitted, the first page is returned.

We recommend transmitting the value of the output parameter nextPageToken, received during the last request.

If set page_token and the request has parameters page and pageSize they are ignored.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
    "dateFrom": "string",
    "dateTo": "string",
    "statuses": [
        "OUTBOUND_CREATED"
    ],
    "orderIds": [
        0
    ],
    "cancelledOrders": true
}

Name

Description

dateFrom*

Type: string<date>

The starting date for filtering by shipment date (inclusive).

Date format: DD-MM-YYYY.

dateTo*

Type: string<date>

The end date for filtering by shipment date (inclusive).

Date format: DD-MM-YYYY.

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

orderIds

Type: integer[]

A list of order IDs from shipments.
The order ID.

Min items: 1

Unique items  

statuses

Type: string[]

List of shipment statuses.
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

Min items: 1

Unique items  

Responses

200 OK

Shipments found.

Body

application/json
{
    "status": "OK",
    "result": {
        "shipments": [
            {
                "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
                },
                "status": "OUTBOUND_CREATED",
                "statusDescription": "string",
                "statusUpdateTime": "2017-11-21T00:00:00+03:00"
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

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

shipments*

Type: object[]

A list with information about shipments.
A list with information about shipments.
Shipping information.

paging
Type: object

nextPageToken

Type: string

ID of the next results page.

The ID of the next page.

Information about shipments.

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 a single shipment
Next
Shipment confirmation