Receipt of documents on the 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 application documents.

, Limit: 1,000 requests per hour

Request

POST

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

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

Body

application/json

{
    "requestId": 0
}

Name

Description

requestId*

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

Responses

200 OK

A list of documents and links to them.

Body

application/json

{
    "status": "OK",
    "result": {
        "documents": [
            {
                "type": "SUPPLY",
                "url": "string",
                "createdAt": "2022-12-29T18:02:01Z"
            }
        ]
    }
}

Name

Description

result

Type: GetSupplyRequestDocumentsDTO

Information about the application documents.

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

GetSupplyRequestDocumentsDTO

Information about the application documents.

Name

Description

documents*

Type: SupplyRequestDocumentDTO[]

A list of documents.
The application document.

Min items: 0

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`

SupplyRequestDocumentDTO

The application document.

Name	Description
createdAt*	Type: string<date-time> The date and time when the document was created.
type*	Type: SupplyRequestDocumentType Document type: Documents that the store uploads `SUPPLY` — a list of products. `ADDITIONAL_SUPPLY` — the list of products in the additional delivery. `VIRTUAL_DISTRIBUTION_CENTER_SUPPLY` — list of products in multi-delivery. `TRANSFER` — a list of items for recycling. `WITHDRAW` — a list of goods for export. Delivery of goods `VALIDATION_ERRORS` — errors in the delivery of goods. `CARGO_UNITS` — labels for cargo locations. Additional delivery and rejected goods `ADDITIONAL_SUPPLY_ACCEPTABLE_GOODS` — products that are suitable for additional delivery. `ADDITIONAL_SUPPLY_UNACCEPTABLE_GOODS` — export of rejected goods. Labeling of goods `INBOUND_UTD` — incoming UPD. `OUTBOUND_UTD` — outgoing UPD. `IDENTIFIERS` — product labeling codes. `CIS_FACT` — accepted products with labeling codes. `ITEMS_WITH_CISES` — products that need labeling. `REPORT_OF_WITHDRAW_WITH_CISES` — marked goods for export from the warehouse. `SECONDARY_ACCEPTANCE_CISES` — marked goods that are accepted after secondary acceptance. `RNPT_FACT` — accepted goods with the batch registration number (RNPT). Acts `ACT_OF_WITHDRAW` — the act of return. `ANOMALY_CONTAINERS_WITHDRAW_ACT` — the act of withdrawal of the rejected goods. `ACT_OF_WITHDRAW_FROM_STORAGE` — the act of writing off from responsible storage. `ACT_OF_RECEPTION_TRANSFER` — acceptance and transfer certificate. `ACT_OF_DISCREPANCY` — the act of discrepancies. `SECONDARY_RECEPTION_ACT` — the act of secondary acceptance. Enum: `SUPPLY`, `ADDITIONAL_SUPPLY`, `VIRTUAL_DISTRIBUTION_CENTER_SUPPLY`, `TRANSFER`, `INBOUND_UTD`, `OUTBOUND_UTD`, `ADDITIONAL_SUPPLY_ACCEPTABLE_GOODS`, `ADDITIONAL_SUPPLY_UNACCEPTABLE_GOODS`, `VALIDATION_ERRORS`, `WITHDRAW`, `ACT_OF_WITHDRAW`, `ANOMALY_CONTAINERS_WITHDRAW_ACT`, `ACT_OF_WITHDRAW_FROM_STORAGE`, `ACT_OF_RECEPTION_TRANSFER`, `ACT_OF_DISCREPANCY`, `SECONDARY_RECEPTION_ACT`, `CARGO_UNITS`, `IDENTIFIERS`, `CIS_FACT`, `ITEMS_WITH_CISES`, `REPORT_OF_WITHDRAW_WITH_CISES`, `SECONDARY_ACCEPTANCE_CISES`, `RNPT_FACT`
url*	Type: string Link to the document. Min length: `1` Max length: `2000`

SupplyRequestDocumentType

Document type:

Documents that the store uploads
- SUPPLY — a list of products.
- ADDITIONAL_SUPPLY — the list of products in the additional delivery.
- VIRTUAL_DISTRIBUTION_CENTER_SUPPLY — list of products in multi-delivery.
- TRANSFER — a list of items for recycling.
- WITHDRAW — a list of goods for export.
Delivery of goods
- VALIDATION_ERRORS — errors in the delivery of goods.
- CARGO_UNITS — labels for cargo locations.
Additional delivery and rejected goods
- ADDITIONAL_SUPPLY_ACCEPTABLE_GOODS — products that are suitable for additional delivery.
- ADDITIONAL_SUPPLY_UNACCEPTABLE_GOODS — export of rejected goods.
Labeling of goods
- INBOUND_UTD — incoming UPD.
- OUTBOUND_UTD — outgoing UPD.
- IDENTIFIERS — product labeling codes.
- CIS_FACT — accepted products with labeling codes.
- ITEMS_WITH_CISES — products that need labeling.
- REPORT_OF_WITHDRAW_WITH_CISES — marked goods for export from the warehouse.
- SECONDARY_ACCEPTANCE_CISES — marked goods that are accepted after secondary acceptance.
- RNPT_FACT — accepted goods with the batch registration number (RNPT).
Acts
- ACT_OF_WITHDRAW — the act of return.
- ANOMALY_CONTAINERS_WITHDRAW_ACT — the act of withdrawal of the rejected goods.
- ACT_OF_WITHDRAW_FROM_STORAGE — the act of writing off from responsible storage.
- ACT_OF_RECEPTION_TRANSFER — acceptance and transfer certificate.
- ACT_OF_DISCREPANCY — the act of discrepancies.
- SECONDARY_RECEPTION_ACT — the act of secondary acceptance.

Type

Description

SupplyRequestDocumentType

Enum: SUPPLY, ADDITIONAL_SUPPLY, VIRTUAL_DISTRIBUTION_CENTER_SUPPLY, TRANSFER, INBOUND_UTD, OUTBOUND_UTD, ADDITIONAL_SUPPLY_ACCEPTABLE_GOODS, ADDITIONAL_SUPPLY_UNACCEPTABLE_GOODS, VALIDATION_ERRORS, WITHDRAW, ACT_OF_WITHDRAW, ANOMALY_CONTAINERS_WITHDRAW_ACT, ACT_OF_WITHDRAW_FROM_STORAGE, ACT_OF_RECEPTION_TRANSFER, ACT_OF_DISCREPANCY, SECONDARY_RECEPTION_ACT, CARGO_UNITS, IDENTIFIERS, CIS_FACT, ITEMS_WITH_CISES, REPORT_OF_WITHDRAW_WITH_CISES, SECONDARY_ACCEPTANCE_CISES, RNPT_FACT

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

Was the article helpful?

Products in the application

One point of sale