Receiving information about orders for delivery, removal and disposal

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/campaigns/{campaignId}/supply-requests

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

Query parameters

Name

Description

limit

Type: integer<int32>

The number of values per page.
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<int64>[]

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

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 application 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.

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

Min items: 1

Unique items  

requestSubtypes

Type: SupplyRequestSubType[]

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.

  • 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 — the parent application for the delivery of goods to the storage warehouse or multi-delivery.

  • VIRTUAL_DISTRIBUTION_CENTER_CHILD — a subsidiary application 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-grading for the better.

  • MISGRADING_WITHDRAW — re-grading in a smaller direction.

  • MAN_UTIL — manual disposal at the request of the warehouse.

Enum: DEFAULT, XDOC, INVENTORYING_SUPPLY, INVENTORYING_SUPPLY_WAREHOUSE_BASED_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

Min items: 1

Unique items  

requestTypes

Type: SupplyRequestType[]

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

Sorting parameters.

SupplyRequestStatusType

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 application 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.

Type

Description

SupplyRequestStatusType

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

SupplyRequestSubType

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.

  • 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 — the parent application for the delivery of goods to the storage warehouse or multi-delivery.

  • VIRTUAL_DISTRIBUTION_CENTER_CHILD — a subsidiary application 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-grading for the better.

  • MISGRADING_WITHDRAW — re-grading in a smaller direction.

  • MAN_UTIL — manual disposal at the request of the warehouse.

Type

Description

SupplyRequestSubType

Enum: DEFAULT, XDOC, INVENTORYING_SUPPLY, INVENTORYING_SUPPLY_WAREHOUSE_BASED_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

SupplyRequestType

Application type:

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

Type

Description

SupplyRequestType

Enum: SUPPLY, WITHDRAW, UTILIZATION

SupplyRequestSortingDTO

Sorting parameters.

Name

Description

attribute*

Type: SupplyRequestSortAttributeType

Which parameter to sort applications by:

  • ID — 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 — application update time.

  • STATUS — application status.

Enum: ID, REQUESTED_DATE, UPDATED_AT, STATUS

direction*

Type: SortOrderType

Sorting direction:

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

Enum: ASC, DESC

SupplyRequestSortAttributeType

Which parameter to sort applications by:

  • ID — 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 — application update time.

  • STATUS — application status.

Type

Description

SupplyRequestSortAttributeType

Enum: ID, REQUESTED_DATE, UPDATED_AT, STATUS

SortOrderType

Sorting direction:

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

Type

Description

SortOrderType

Enum: ASC, DESC

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

result

Type: GetSupplyRequestsDTO

A list of applications and information on them.

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

GetSupplyRequestsDTO

A list of applications and information on them.

Name

Description

requests*

Type: SupplyRequestDTO[]

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

Min items: 0

Max items: 100

paging

Type: ForwardScrollingPagerDTO

The ID of the next page.

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

SupplyRequestDTO

Information about the request for delivery, removal or disposal.

Name

Description

counters*

Type: SupplyRequestCountersDTO

The number of goods, boxes and pallets in the application.

id*

Type: SupplyRequestIdDTO

The application ID and numbers.

status*

Type: SupplyRequestStatusType

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 application 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.

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

subtype*

Type: SupplyRequestSubType

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.

  • 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 — a parent application for the delivery of goods to a storage warehouse or multi-delivery.

  • VIRTUAL_DISTRIBUTION_CENTER_CHILD — a subsidiary application 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-grading for the better.

  • MISGRADING_WITHDRAW — re-grading in a smaller direction.

  • MAN_UTIL — manual disposal at the request of the warehouse.

Enum: DEFAULT, XDOC, INVENTORYING_SUPPLY, INVENTORYING_SUPPLY_WAREHOUSE_BASED_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

targetLocation*

Type: SupplyRequestLocationDTO

Information about the storage warehouse or PVZ.

type*

Type: SupplyRequestType

Application type:

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

Enum: SUPPLY, WITHDRAW, UTILIZATION

updatedAt*

Type: string<date-time>

The date and time of the last application update.

childrenLinks

Type: SupplyRequestReferenceDTO[]

Links to child applications.
Information about related applications.

Min items: 1

parentLink

Type: SupplyRequestReferenceDTO

Link to the parent application.

transitLocation

Type: SupplyRequestLocationDTO

Information about the transit warehouse or PVZ.

ForwardScrollingPagerDTO

The ID of the next page.

Name

Description

nextPageToken

Type: string

ID of the next results page.

SupplyRequestCountersDTO

The number of goods, boxes and pallets in the application.

Name

Description

acceptableCount

Type: integer<int32>

The number of items that can be brought additionally.

Min value: 0

actualBoxCount

Type: integer<int32>

The number of boxes that are accepted in the warehouse.

Min value: 0

actualPalletsCount

Type: integer<int32>

The number of pallets that are accepted in the warehouse.

Min value: 0

defectCount

Type: integer<int32>

The number of defective products.

Min value: 0

factCount

Type: integer<int32>

The number of items that are accepted in the warehouse.

Min value: 0

planCount

Type: integer<int32>

The number of items in the delivery request.

Min value: 0

shortageCount

Type: integer<int32>

The number of defective products.

Min value: 0

surplusCount

Type: integer<int32>

The number of extra items.

Min value: 0

unacceptableCount

Type: integer<int32>

The number of items that cannot be delivered additionally.

Min value: 0

undefinedCount

Type: integer<int32>

The number of rejected products.

Min value: 0

SupplyRequestIdDTO

The application ID and numbers.

Name

Description

id*

Type: integer<int64>

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

marketplaceRequestId

Type: string

The application number on the marketplace.

It is also indicated in the seller's account on the Market.

warehouseRequestId

Type: string

The order number in the warehouse.

It is also indicated in the seller's account on the Market.

SupplyRequestLocationDTO

Information about the warehouse or PVZ in the application.

Name

Description

address*

Type: SupplyRequestLocationAddressDTO

The address of the warehouse or PVZ.

name*

Type: string

The name of the warehouse or PVZ.

serviceId*

Type: integer<int64>

ID of the warehouse or logistics partner of the PVZ.

type*

Type: SupplyRequestLocationType

Type of warehouse or PVZ:

  • FULFILLMENT — storage warehouse.
  • XDOC — transit warehouse.
  • PICKUP_POINT — PVZ.

Enum: FULFILLMENT, XDOC, PICKUP_POINT

requestedDate

Type: string<date-time>

Date and time of delivery to the warehouse or to the PVZ.

SupplyRequestReferenceDTO

Information about related applications.

Name

Description

id*

Type: SupplyRequestIdDTO

IDs of the related application.

type*

Type: SupplyRequestReferenceType

The type of connection.

Enum: VIRTUAL_DISTRIBUTION, WITHDRAW, UTILIZATION, ADDITIONAL_SUPPLY

SupplyRequestLocationAddressDTO

The address of the warehouse or PVZ.

Name

Description

fullAddress*

Type: string

The full address of the warehouse or PVZ.

gps*

Type: GpsDTO

GPS coordinates of latitude and longitude.

SupplyRequestLocationType

Type of warehouse or PVZ:

  • FULFILLMENT — storage warehouse.
  • XDOC — transit warehouse.
  • PICKUP_POINT — PVZ.

Type

Description

SupplyRequestLocationType

Enum: FULFILLMENT, XDOC, PICKUP_POINT

SupplyRequestReferenceType

The type of connection between the two applications:

  • VIRTUAL_DISTRIBUTION — multi-delivery.

  • WITHDRAW — export of rejected goods.

    Subtypes of the application: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD and ANOMALY_WITHDRAW.

  • UTILIZATION — disposal of rejected goods.

    Subtypes of the application: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD and FORCE_PLAN_ANOMALY_PER_SUPPLY.

  • ADDITIONAL_SUPPLY — additional delivery.

    Subtypes of the application: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD and ADDITIONAL_SUPPLY.

Type

Description

SupplyRequestReferenceType

Enum: VIRTUAL_DISTRIBUTION, WITHDRAW, UTILIZATION, ADDITIONAL_SUPPLY

GpsDTO

GPS coordinates of latitude and longitude.

Name

Description

latitude*

Type: number<decimal>

Width.

longitude*

Type: number<decimal>

Longitude.

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

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 of 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

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

Read about what it is in Yandex.Market Help for sellers.

Previous
Information about the ability to print labels (FBS)
Next
Products in the application