Receiving information about orders for delivery, removal and disposal

Info

Console

The method is available for the FBY model.

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

supplies-management:read-only — View FBY requests
all-methods — Full account management
all-methods:read-only — View all data

Returns requests for delivery, export, and disposal, as well as information on them, using the specified filters.

⚙️ Limit: 1,000 requests per hour

Request

POST

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/supply-requests

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

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

{
    "requestIds": [
        0
    ],
    "requestDateFrom": "2022-12-29T18:02:01Z",
    "requestDateTo": "2022-12-29T18:02:01Z",
    "requestTypes": [
        "SUPPLY"
    ],
    "requestSubtypes": [
        "DEFAULT"
    ],
    "requestStatuses": [
        "CREATED"
    ],
    "sorting": {
        "direction": "ASC",
        "attribute": "ID"
    }
}

Name

Description

requestDateFrom

Type: string<date-time>

The start date of the request filtering period.

requestDateTo

Type: string<date-time>

The end date of the request filtering period.

requestIds

Type: integer[]

Request IDs.
The application ID.

Used only in the API

It will not be possible to find applications in the seller's account on the Market. To do this, use marketplaceRequestId or warehouseRequestId.

Min value: 1

Min items: 1

Max items: 100

Unique items

requestStatuses

Type: string[]

Request statuses for filtering.
Delivery request status:

CREATED — A draft application has been created.
FINISHED — The application is completed, the goods are:
- accepted at the warehouse;
- transferred to another warehouse during the transfer;
- transferred to the seller during export;
- disposed of.
CANCELLED — the application has been cancelled.
INVALID — processing error.
VALIDATED — the application is being processed.
PUBLISHED — An application has been created.
ARRIVED_TO_SERVICE — The delivery has arrived at the storage warehouse.
ARRIVED_TO_XDOC_SERVICE — The delivery has arrived at the transit warehouse.
SHIPPED_TO_SERVICE — The delivery was sent from the transit warehouse to the storage warehouse.
CANCELLATION_REQUESTED — cancellation of the request has been requested.
CANCELLATION_REJECTED — The application will not be cancelled.
REGISTERED_IN_ELECTRONIC_QUEUE — the delivery is registered in the electronic queue.
READY_FOR_UTILIZATION — the goods are ready for disposal.
TRANSIT_MOVING — moving goods to the export warehouse.
WAREHOUSE_HANDLING — secondary acceptance of goods or their assembly for export or disposal.
ACCEPTED_BY_WAREHOUSE_SYSTEM — information about the application has been sent to the warehouse.
READY_TO_WITHDRAW — the goods are ready for delivery.
NEED_PREPARATION — information is expected from the seller.

Enum: CREATED, FINISHED, CANCELLED, INVALID, VALIDATED, PUBLISHED, ARRIVED_TO_SERVICE, ARRIVED_TO_XDOC_SERVICE, SHIPPED_TO_SERVICE, CANCELLATION_REQUESTED, CANCELLATION_REJECTED, REGISTERED_IN_ELECTRONIC_QUEUE, READY_FOR_UTILIZATION, TRANSIT_MOVING, WAREHOUSE_HANDLING, ACCEPTED_BY_WAREHOUSE_SYSTEM, READY_TO_WITHDRAW, NEED_PREPARATION

Min items: 1

Unique items

requestSubtypes

Type: string[]

Subtypes of requests for filtering.
Application subtype:

DEFAULT — delivery of goods to or from a storage warehouse.
XDOC — delivery of goods through a transit warehouse or export from it.
INVENTORYING_SUPPLY — inventory in the warehouse at the request of the store.
INVENTORYING_SUPPLY_WAREHOUSE_BASED_PER_SUPPLIER — inventory in the warehouse at the request of the warehouse.
INVENTORYING_SUPPLY_PER_SUPPLIER — inventory in the warehouse at the request of the accounting system.
MOVEMENT_SUPPLY — incoming movement between warehouses.

When moving between warehouses, 2 orders are created — MOVEMENT_SUPPLY and MOVEMENT_WITHDRAW.
ADDITIONAL_SUPPLY — additional delivery of rejected goods.
VIRTUAL_DISTRIBUTION_CENTER — parent request for delivery of goods to a storage warehouse or multi-delivery.
VIRTUAL_DISTRIBUTION_CENTER_CHILD — a subsidiary request for the delivery of goods to a storage warehouse or multi-delivery.

It doesn't come back for her transitLocation.
FORCE_PLAN — automatic disposal at the request of the warehouse.
FORCE_PLAN_ANOMALY_PER_SUPPLY — disposal of rejected goods.
PLAN_BY_SUPPLIER — disposal at the request of the store.
ANOMALY_WITHDRAW — export of rejected goods.
FIX_LOST_INVENTORYING — items that were not found after the second inventory.
OPER_LOST_INVENTORYING — items that were not found after the first inventory.
MOVEMENT_WITHDRAW — outbound movement between warehouses.

When moving between warehouses, 2 orders are created — MOVEMENT_SUPPLY and MOVEMENT_WITHDRAW.
MISGRADING_SUPPLY — re-sorting for the better.
MISGRADING_WITHDRAW — re-sorting in a smaller direction.
MAN_UTIL — manual disposal at the request of the warehouse.
WITHDRAW_AUTO_UTILIZATION — automatic disposal of goods in the export order when their storage period has expired.

Enum: DEFAULT, XDOC, INVENTORYING_SUPPLY, INVENTORYING_SUPPLY_WAREHOUSE_BASED_PER_SUPPLIER, INVENTORYING_SUPPLY_PER_SUPPLIER, MOVEMENT_SUPPLY, ADDITIONAL_SUPPLY, VIRTUAL_DISTRIBUTION_CENTER, VIRTUAL_DISTRIBUTION_CENTER_CHILD, FORCE_PLAN, FORCE_PLAN_ANOMALY_PER_SUPPLY, PLAN_BY_SUPPLIER, ANOMALY_WITHDRAW, FIX_LOST_INVENTORYING, OPER_LOST_INVENTORYING, MOVEMENT_WITHDRAW, MISGRADING_SUPPLY, MISGRADING_WITHDRAW, MAN_UTIL, WITHDRAW_AUTO_UTILIZATION

Min items: 1

Unique items

requestTypes

Type: string[]

Types of requests to filter.
Application type:

SUPPLY — delivery of goods.
WITHDRAW — export of goods.
UTILIZATION — disposal of goods.

Enum: SUPPLY, WITHDRAW, UTILIZATION

Min items: 1

Unique items

sorting

Type: object

attribute*

Type: string

Which parameter to sort applications by:

ID — the application ID.
REQUESTED_DATE — date of delivery to the storage warehouse.

If the goods passed through a transit warehouse, it sorts them by delivery dates to both warehouses.
UPDATED_AT — the time of the application update.
STATUS — the status of the application.

Enum: ID, REQUESTED_DATE, UPDATED_AT, STATUS

direction*

Type: string

Sorting direction:

ASC — sort in ascending order.
DESC — sort in descending order.

Enum: ASC, DESC

Sorting parameters.

Responses

200 OK

A list of applications and information on them.

Body

application/json

{
    "status": "OK",
    "result": {
        "requests": [
            {
                "id": {
                    "id": 0,
                    "marketplaceRequestId": "string",
                    "warehouseRequestId": "string"
                },
                "type": "SUPPLY",
                "subtype": "DEFAULT",
                "status": "CREATED",
                "updatedAt": "2022-12-29T18:02:01Z",
                "counters": {
                    "planCount": 0,
                    "factCount": 0,
                    "undefinedCount": 0,
                    "surplusCount": 0,
                    "shortageCount": 0,
                    "defectCount": 0,
                    "acceptableCount": 0,
                    "unacceptableCount": 0,
                    "actualPalletsCount": 0,
                    "actualBoxCount": 0
                },
                "parentLink": {
                    "id": {
                        "id": 0,
                        "marketplaceRequestId": "string",
                        "warehouseRequestId": "string"
                    },
                    "type": "VIRTUAL_DISTRIBUTION"
                },
                "childrenLinks": [
                    {
                        "id": {
                            "id": 0,
                            "marketplaceRequestId": "string",
                            "warehouseRequestId": "string"
                        },
                        "type": "VIRTUAL_DISTRIBUTION"
                    }
                ],
                "targetLocation": {
                    "requestedDate": "2022-12-29T18:02:01Z",
                    "serviceId": 0,
                    "name": "string",
                    "address": {
                        "fullAddress": "string",
                        "gps": {
                            "latitude": 0,
                            "longitude": 0
                        }
                    },
                    "type": "FULFILLMENT"
                },
                "transitLocation": {
                    "requestedDate": "2022-12-29T18:02:01Z",
                    "serviceId": 0,
                    "name": "string",
                    "address": {
                        "fullAddress": "string",
                        "gps": {
                            "latitude": 0,
                            "longitude": 0
                        }
                    },
                    "type": "FULFILLMENT"
                }
            }
        ],
        "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

requests*

Type: object[]

The list of applications.
Information about the request for delivery, removal or disposal.

Min items: 0

Max items: 100

paging

Type: object

nextPageToken

Type: string

ID of the next results page.

The ID of the next page.

A list of applications and information on them.

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

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

Was the article helpful?

Labels for trust acceptance (FBS)

Products in the application