Receipt of goods in an application for delivery, export or 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 the list of products in the application and information about them.

⚙️ Limit: 1,000 requests per hour

Request

POST

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

You can find it using a query :no-translate[GET v2/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 API → 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.

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

{
    "requestId": 0
}

Name

Description

requestId*

Type: integer<int64>

The application ID.

Used only in 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

Responses

200 OK

The list of products in the application and information about them.

Body

application/json

{
    "status": "OK",
    "result": {
        "items": [
            {
                "offerId": "string",
                "name": "string",
                "price": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "counters": {
                    "planCount": 0,
                    "factCount": 0,
                    "surplusCount": 0,
                    "shortageCount": 0,
                    "defectCount": 0
                }
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

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

result

Type: GetSupplyRequestItemsDTO

Information about the products in the application.

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`

GetSupplyRequestItemsDTO

Information about the products in the application.

Name

Description

items*

Type: SupplyRequestItemDTO[]

The list of products.
Product information in the application.

Min items: 0

Max items: 100

paging

Type: ForwardScrollingPagerDTO

The ID of the next page.

SupplyRequestItemDTO

Product information in the application.

Name	Description
counters*	Type: SupplyRequestItemCountersDTO Количество товаров в заявке.
name*	Type: string Product name.
offerId*	Type: string Your SKU — the product ID in your system. Usage rules SKU: For each product SKU there must be one. Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before. SKU The product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers. What is SKU and how to assign it Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$`
price	Type: CurrencyValueDTO Currency and its value.

ForwardScrollingPagerDTO

The ID of the next page.

Name

Description

nextPageToken

Type: string

ID of the next results page.

SupplyRequestItemCountersDTO

The number of products in the application.

Name	Description
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`

CurrencyValueDTO

Currency and its value.

Name

Description

currencyId*

Type: CurrencyType

Валюта.

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

value*

Type: number

Meaning.

CurrencyType

Currency codes:

RUR — Russian ruble.
UAH — the Ukrainian hryvnia.
BYR — Belarusian ruble.
KZT — Kazakhstani tenge.
UZS — Uzbek sum.

Type

Description

CurrencyType

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

Information about applications

Application documents