Confirmation of the nearest shipment and receipt of the acceptance certificate for it
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
- inventory-and-order-processing — Order processing and inventory
- all-methods — Full account management
The request confirms the next shipment and returns the acceptance certificate in the format PDF.
Express delivery
If your store is connected to express delivery and you ship orders to couriers Yandex Go, it is not necessary to prepare the acceptance certificate.
The act includes collected and ready-to-ship orders that are shipped to a sorting center or a pick-up point or to Market couriers.
When forming an act, the Market automatically finds and inserts the following data into the template:
The data from which the Market generates the report
|
Data in the report |
Description |
|
Sender |
The name of your legal entity indicated in the seller's account on the Market. |
|
Executor |
The name of the legal entity of the sorting center or delivery service. |
|
Shipment number in the customer's system |
The field is no longer in use Your order ID, which you provided in the response to the request |
|
Shipment number in the contractor's (subcontractor's) system |
The ID of the order on the Market, as in the request output GET v2/campaigns/{campaignId}/orders. |
|
Declared value |
The total amount of the order excluding the shipping cost, as shown in the request output GET v2/campaigns/{campaignId}/orders or GET v2/campaigns/{campaignId}/orders/{orderId}. |
|
The cost of all the items in the order |
The cost of all ordered items. |
|
Weight |
The gross weight of the cargo area (the total weight of the package and contents), as in the request output GET v2/campaigns/{campaignId}/orders or GET v2/campaigns/{campaignId}/orders/{orderId}. |
|
Number of seats |
The number of cargo spaces in the order, as shown in the request output GET v2/campaigns/{campaignId}/orders or GET v2/campaigns/{campaignId}/orders/{orderId}. |
In the printed statement, specify the sender and the contractor. They must sign the act and indicate their last name and initials next to the signature. If necessary, also fill in the details of the power of attorney.
| ⚙️ Limit: 100 requests per hour |
|---|
Request
GET
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/shipments/reception-transfer-act
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:
, Do not send the store's ID instead, which is indicated in the seller's account on the Market next to the store's name and in some reports.
Min value: |
Query parameters
|
Name |
Description |
|
signatory |
Type: string The username of the user in Yandex ID, on whose behalf the electronic acceptance certificate will be signed. Specified without Where to find it:
|
|
warehouse_id |
Type: integer<int32> The warehouse ID. Min value: |
Responses
200 OK
Acceptance and transfer certificate in the format PDF.
Body
application/pdf
Type: string
Format: binary
400 Bad Request
The request contains incorrect data. More information about the error
| Description | Explanation | Solution methods |
|---|---|---|
| Closest shipment for reception transfer act generation not found | Shipments with the status Can be processed not found. | Create a purchase order or wait for the existing order to be upgraded to the desired status. |
| No orders for closest shipment have been processed yet | There are no orders in the next shipment. | Check that the orders have the parameter status it matters PROCESSING, and the parameter substatus — READY_TO_SHIP. You can get the statuses and shipping dates of orders using queries GET v2/campaigns/{campaignId}/orders and GET v2/campaigns/{campaignId}/orders/{orderId}, change order statuses using requests PUT v2/campaigns/{campaignId}/orders/{orderId}/status and POST v2/campaigns/{campaignId}/orders/status‑update. |
| Some orders are in the process of being excluded from shipment {orders id}. Please wait up to 30 minutes and try again | IDs of orders in the nearest shipment that are in the process of being deleted from it. | Transferring orders can take up to 30 minutes. Wait for the transfer to finish and try again. |
| Some orders have not been processed yet. Please change the status of orders to READY_TO_SHIP and try again. {orders id} | IDs of orders in the nearest shipment that have not yet been processed. | Send for orders with the specified IDs status: PROCESSING and substatus: READY_TO_SHIP and try again. You can change the order statuses using queries PUT v2/campaigns/{campaignId}/orders/{orderId}/status and POST v2/campaigns/{campaignId}/orders/status‑update. |
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] A list of errors. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
ApiErrorDTO
The general error format.
|
Name |
Description |
|
code* |
Type: string The error code. |
|
message |
Type: string Description of the error. |
ApiResponseStatusType
The type of response. Possible values:
OK— there are no mistakes.ERROR— an error occurred while processing the request.
|
Type |
Description |
|
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.