接收有关交付、移除和处置订单的信息
方法适用于模式FBY.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
- supplies-management:read-only — 获取有关FBY应用程序的信息
- all-methods — 全面管理账户
- all-methods:read-only — 查看所有数据
使用指定的筛选器返回交付、导出和处置请求以及有关这些请求的信息。
| ⚙️ 限制: 每小时1,000个请求 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/supply-requests
Path parameters
|
Name |
Description |
|
campaignId |
Type: integer 广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要把它与:
Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer 每页的值数。 Min value: |
|
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 Example: |
Body
application/json
{
"requestIds": [
1
],
"requestDateFrom": "2025-01-01T00:00:00Z",
"requestDateTo": "2025-01-01T00:00:00Z",
"requestTypes": [
"SUPPLY"
],
"requestSubtypes": [
"DEFAULT"
],
"requestStatuses": [
"CREATED"
],
"sorting": {
"direction": "ASC",
"attribute": "ID"
}
}
|
Name |
Description |
||||
|
requestDateFrom |
Type: string<date-time> | null 请求过滤时段的开始日期。 Example: |
||||
|
requestDateTo |
Type: string<date-time> | null 请求过滤期的结束日期。 Example: |
||||
|
requestIds |
Type: integer[] | null 请求Id。 Min items: Max items: Unique items: Example
|
||||
|
requestStatuses |
Type: string[] | null 请求状态进行过滤。 Min items: Unique items: Example
|
||||
|
requestSubtypes |
Type: string[] | null 过滤请求的子类型。 Min items: Unique items: Example
|
||||
|
requestTypes |
Type: string[] | null 要过滤的请求类型。 Min items: Unique items: Example
|
||||
|
sorting |
Type: object
排序参数。 Example
|
Responses
200 OK
应用程序列表及其信息。
Body
application/json
{
"status": "OK",
"result": {
"requests": [
{
"id": {},
"type": "SUPPLY",
"subtype": "DEFAULT",
"status": "CREATED",
"updatedAt": "2025-01-01T00:00:00Z",
"counters": {},
"parentLink": {},
"childrenLinks": [
null
],
"targetLocation": {},
"transitLocation": {}
}
],
"paging": {
"nextPageToken": "example"
}
}
}
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
result
Type: object
requests
Type: object[]
counters
Type: object
acceptableCount
Type: integer
可以额外携带的物品数量。
Min value:
0actualBoxCount
Type: integer
仓库中接受的箱子数量。
Min value:
0actualPalletsCount
Type: integer
仓库中接受的托盘数量。
Min value:
0defectCount
Type: integer
次品的数量。
Min value:
0factCount
Type: integer
仓库中接受的物料数量。
Min value:
0planCount
Type: integer
交付请求中的项目数量。
Min value:
0shortageCount
Type: integer
次品的数量。
Min value:
0surplusCount
Type: integer
额外项目的数量。
Min value:
0unacceptableCount
Type: integer
无法额外交付的项目数量。
Min value:
0undefinedCount
Type: integer
拒收产品的数量。
Min value:
0应用程序中的货物,箱子和托盘的数量。
Example
{ "planCount": 0, "factCount": 0, "undefinedCount": 0, "surplusCount": 0, "shortageCount": 0, "defectCount": 0, "acceptableCount": 0, "unacceptableCount": 0, "actualPalletsCount": 0, "actualBoxCount": 0 }id
Type: object
id
Type: integer
的应用程序ID。
仅在API中使用
在市场上无法在卖方的帐户中找到应用程序。 要做到这一点,请使用
marketplaceRequestId或warehouseRequestId.Min value:
1marketplaceRequestId
Type: string
市场上的申请号。
它也在市场上的卖家账户中注明。
Example:
examplewarehouseRequestId
Type: string
仓库中的订单号。
它也在市场上的卖家账户中注明。
Example:
example应用程序ID和编号。
Example
{ "id": 1, "marketplaceRequestId": "example", "warehouseRequestId": "example" }status
Type: string
送货请求状态:
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— 信息是期望从卖方。
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_PREPARATIONsubtype
Type: string
应用程序子类型:
-
DEFAULT— 将货物运往或运出仓库. -
XDOC— 通过中转仓库交付货物或从中出口。 -
INVENTORYING_SUPPLY— 应商店的要求在仓库库存。 -
INVENTORYING_SUPPLY_WAREHOUSE_BASED_PER_SUPPLIER— 仓库的要求在仓库库存。 -
MOVEMENT_SUPPLY— 仓库之间的进货运动。在仓库之间移动时,将创建2个订单 —
MOVEMENT_SUPPLY和MOVEMENT_WITHDRAW. -
ADDITIONAL_SUPPLY— 拒绝货物的额外交付。 -
VIRTUAL_DISTRIBUTION_CENTER— 父母要求将货物交付到存储仓库或多交付. -
VIRTUAL_DISTRIBUTION_CENTER_CHILD— 将货物交付到存储仓库或[多交付]的附属请求(*multisupply).它不会为她回来的
transitLocation. -
FORCE_PLAN— 在仓库的要求自动处置。 -
FORCE_PLAN_ANOMALY_PER_SUPPLY— 弃置被拒货物。 -
PLAN_BY_SUPPLIER— 在商店的要求处置。 -
ANOMALY_WITHDRAW— 出口拒收货物。 -
FIX_LOST_INVENTORYING— 第二次清点后未找到的物品。 -
OPER_LOST_INVENTORYING— 第一次清点后未找到的物品。 -
MOVEMENT_WITHDRAW— 仓库之间的出库移动。在仓库之间移动时,将创建2个订单 —
MOVEMENT_SUPPLY和MOVEMENT_WITHDRAW. -
MISGRADING_SUPPLY— 重新排序变得更好。 -
MISGRADING_WITHDRAW— 较小的方向重新排序。 -
MAN_UTIL— 在仓库的要求人工处置。 -
WITHDRAW_AUTO_UTILIZATION— 当货物储存期届满时,出口订单中的货物自动处置.
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,WITHDRAW_AUTO_UTILIZATIONtargetLocation
Type: object
address
Type: object
fullAddress
Type: string
仓库或PVZ的完整地址。
Example:
examplegps
Type: object
latitude
Type: number
宽度。
longitude
Type: number
经度。
纬度和经度的GPS坐标。
Example
{ "latitude": 0.5, "longitude": 0.5 }仓库或PVZ的地址。
Example
{ "fullAddress": "example", "gps": { "latitude": 0.5, "longitude": 0.5 } }name
Type: string
仓库或PVZ的名称。
Example:
exampleserviceId
Type: integer
PVZ的仓库或物流合作伙伴的ID。
type
Type: string
仓库或PVZ类型:
FULFILLMENT— 仓储仓库。XDOC— 中转仓库。PICKUP_POINT— PVZ。
Enum:
FULFILLMENT,XDOC,PICKUP_POINTrequestedDate
Type: string<date-time>
交货到仓库或PVZ的日期和时间.
Example:
2025-01-01T00:00:00Z应用程序中有关仓库或PVZ的信息。
Example
{ "requestedDate": "2025-01-01T00:00:00Z", "serviceId": 0, "name": "example", "address": { "fullAddress": "example", "gps": { "latitude": 0.5, "longitude": 0.5 } }, "type": "FULFILLMENT" }type
Type: string
申请类别:
SUPPLY— 交付货物。WITHDRAW— 货物出口。UTILIZATION— 货物的处置。
Enum:
SUPPLY,WITHDRAW,UTILIZATIONupdatedAt
Type: string<date-time>
上次应用程序更新的日期和时间。
Example:
2025-01-01T00:00:00ZchildrenLinks
Type: object[]
id
Type: object
id
Type: integer
的应用程序ID。
仅在API中使用
在市场上无法在卖方的帐户中找到应用程序。 要做到这一点,请使用
marketplaceRequestId或warehouseRequestId.Min value:
1marketplaceRequestId
Type: string
市场上的申请号。
它也在市场上的卖家账户中注明。
Example:
examplewarehouseRequestId
Type: string
仓库中的订单号。
它也在市场上的卖家账户中注明。
Example:
example应用程序ID和编号。
Example
{ "id": 1, "marketplaceRequestId": "example", "warehouseRequestId": "example" }type
Type: string
两个应用程序之间的连接类型:
-
VIRTUAL_DISTRIBUTION— 多派递. -
WITHDRAW— 出口拒收货物。应用程序的子类型:
DEFAULT,XDOC,VIRTUAL_DISTRIBUTION_CENTER_CHILD和ANOMALY_WITHDRAW. -
UTILIZATION— 弃置被拒货物。应用程序的子类型:
DEFAULT,XDOC,VIRTUAL_DISTRIBUTION_CENTER_CHILD和FORCE_PLAN_ANOMALY_PER_SUPPLY. -
ADDITIONAL_SUPPLY— 额外的交付。应用程序的子类型:
DEFAULT,XDOC,VIRTUAL_DISTRIBUTION_CENTER_CHILD和ADDITIONAL_SUPPLY.
Enum:
VIRTUAL_DISTRIBUTION,WITHDRAW,UTILIZATION,ADDITIONAL_SUPPLY子应用程序的链接。
Min items:
1Example
[ { "id": { "id": 1, "marketplaceRequestId": "example", "warehouseRequestId": "example" }, "type": "VIRTUAL_DISTRIBUTION" } ]parentLink
Type: object
id
Type: object
id
Type: integer
的应用程序ID。
仅在API中使用
在市场上无法在卖方的帐户中找到应用程序。 要做到这一点,请使用
marketplaceRequestId或warehouseRequestId.Min value:
1marketplaceRequestId
Type: string
市场上的申请号。
它也在市场上的卖家账户中注明。
Example:
examplewarehouseRequestId
Type: string
仓库中的订单号。
它也在市场上的卖家账户中注明。
Example:
example应用程序ID和编号。
Example
{ "id": 1, "marketplaceRequestId": "example", "warehouseRequestId": "example" }type
Type: string
两个应用程序之间的连接类型:
-
VIRTUAL_DISTRIBUTION— 多派递. -
WITHDRAW— 出口拒收货物。应用程序的子类型:
DEFAULT,XDOC,VIRTUAL_DISTRIBUTION_CENTER_CHILD和ANOMALY_WITHDRAW. -
UTILIZATION— 弃置被拒货物。应用程序的子类型:
DEFAULT,XDOC,VIRTUAL_DISTRIBUTION_CENTER_CHILD和FORCE_PLAN_ANOMALY_PER_SUPPLY. -
ADDITIONAL_SUPPLY— 额外的交付。应用程序的子类型:
DEFAULT,XDOC,VIRTUAL_DISTRIBUTION_CENTER_CHILD和ADDITIONAL_SUPPLY.
Enum:
VIRTUAL_DISTRIBUTION,WITHDRAW,UTILIZATION,ADDITIONAL_SUPPLY相关应用的信息。
Example
{ "id": { "id": 1, "marketplaceRequestId": "example", "warehouseRequestId": "example" }, "type": "VIRTUAL_DISTRIBUTION" }transitLocation
Type: object
address
Type: object
fullAddress
Type: string
仓库或PVZ的完整地址。
Example:
examplegps
Type: object
latitude
Type: number
宽度。
longitude
Type: number
经度。
纬度和经度的GPS坐标。
Example
{ "latitude": 0.5, "longitude": 0.5 }仓库或PVZ的地址。
Example
{ "fullAddress": "example", "gps": { "latitude": 0.5, "longitude": 0.5 } }name
Type: string
仓库或PVZ的名称。
Example:
exampleserviceId
Type: integer
PVZ的仓库或物流合作伙伴的ID。
type
Type: string
仓库或PVZ类型:
FULFILLMENT— 仓储仓库。XDOC— 中转仓库。PICKUP_POINT— PVZ。
Enum:
FULFILLMENT,XDOC,PICKUP_POINTrequestedDate
Type: string<date-time>
交货到仓库或PVZ的日期和时间.
Example:
2025-01-01T00:00:00Z应用程序中有关仓库或PVZ的信息。
Example
{ "requestedDate": "2025-01-01T00:00:00Z", "serviceId": 0, "name": "example", "address": { "fullAddress": "example", "gps": { "latitude": 0.5, "longitude": 0.5 } }, "type": "FULFILLMENT" }的应用程序列表。
Min items:
0Max items:
100Example
[ { "id": { "id": 1, "marketplaceRequestId": "example", "warehouseRequestId": "example" }, "type": "SUPPLY", "subtype": "DEFAULT", "status": "CREATED", "updatedAt": "2025-01-01T00:00:00Z", "counters": { "planCount": 0, "factCount": 0, "undefinedCount": 0, "surplusCount": 0, "shortageCount": 0, "defectCount": 0, "acceptableCount": 0, "unacceptableCount": 0, "actualPalletsCount": 0, "actualBoxCount": 0 }, "parentLink": { "id": { "id": 1, "marketplaceRequestId": "example", "warehouseRequestId": "example" }, "type": "VIRTUAL_DISTRIBUTION" }, "childrenLinks": [ { "id": { "id": 1, "marketplaceRequestId": "example", "warehouseRequestId": "example" }, "type": "VIRTUAL_DISTRIBUTION" } ], "targetLocation": { "requestedDate": "2025-01-01T00:00:00Z", "serviceId": 0, "name": "example", "address": { "fullAddress": "example", "gps": { "latitude": 0.5, "longitude": 0.5 } }, "type": "FULFILLMENT" }, "transitLocation": { "requestedDate": "2025-01-01T00:00:00Z", "serviceId": 0, "name": "example", "address": { "fullAddress": "example", "gps": { "latitude": 0.5, "longitude": 0.5 } }, "type": "FULFILLMENT" } } ]paging
Type: object
nextPageToken
Type: string
下一个结果页面的ID。
Example:
example下一页的ID。
Example
{ "nextPageToken": "example" }应用程序列表及其信息。
Example
{ "requests": [ { "id": { "id": 1, "marketplaceRequestId": "example", "warehouseRequestId": "example" }, "type": "SUPPLY", "subtype": "DEFAULT", "status": "CREATED", "updatedAt": "2025-01-01T00:00:00Z", "counters": { "planCount": 0, "factCount": 0, "undefinedCount": 0, "surplusCount": 0, "shortageCount": 0, "defectCount": 0, "acceptableCount": 0, "unacceptableCount": 0, "actualPalletsCount": 0, "actualBoxCount": 0 }, "parentLink": { "id": { "id": 1, "marketplaceRequestId": "example", "warehouseRequestId": "example" }, "type": "VIRTUAL_DISTRIBUTION" }, "childrenLinks": [ { "id": {}, "type": "VIRTUAL_DISTRIBUTION" } ], "targetLocation": { "requestedDate": "2025-01-01T00:00:00Z", "serviceId": 0, "name": "example", "address": { "fullAddress": "example", "gps": {} }, "type": "FULFILLMENT" }, "transitLocation": { "requestedDate": "2025-01-01T00:00:00Z", "serviceId": 0, "name": "example", "address": { "fullAddress": "example", "gps": {} }, "type": "FULFILLMENT" } } ], "paging": { "nextPageToken": "example" } }Example
{ "result": { "requests": [ { "id": { "id": 1, "marketplaceRequestId": "example", "warehouseRequestId": "example" }, "type": "SUPPLY", "subtype": "DEFAULT", "status": "CREATED", "updatedAt": "2025-01-01T00:00:00Z", "counters": { "planCount": 0, "factCount": 0, "undefinedCount": 0, "surplusCount": 0, "shortageCount": 0, "defectCount": 0, "acceptableCount": 0, "unacceptableCount": 0, "actualPalletsCount": 0, "actualBoxCount": 0 }, "parentLink": { "id": {}, "type": "VIRTUAL_DISTRIBUTION" }, "childrenLinks": [ {} ], "targetLocation": { "requestedDate": "2025-01-01T00:00:00Z", "serviceId": 0, "name": "example", "address": {}, "type": "FULFILLMENT" }, "transitLocation": { "requestedDate": "2025-01-01T00:00:00Z", "serviceId": 0, "name": "example", "address": {}, "type": "FULFILLMENT" } } ], "paging": { "nextPageToken": "example" } } }
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
500 Internal Server Error
Yandex中的内部错误。 市场。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
No longer supported, please use an alternative and newer version.
阅读它在什么 燕基科斯.对卖家的市场帮助.