接收有关交付、移除和处置订单的信息
方法适用于模式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<int64> 活动ID。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。
Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer<int32> 每页的值数。
Min value: |
|
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 |
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> 请求过滤期的开始日期。 |
|
requestDateTo |
Type: string<date-time> 请求过滤期的结束日期。 |
|
requestIds |
Type: integer<int64>[] 请求Id。 仅在API中使用 在市场上无法在卖方的帐户中找到应用程序。 要做到这一点,请使用 Min value: Min items: Max items: Unique items |
|
requestStatuses |
Type: SupplyRequestStatusType[] 请求状态进行过滤。
Enum: Min items: Unique items |
|
requestSubtypes |
Type: SupplyRequestSubType[] 过滤请求的子类型。
Enum: Min items: Unique items |
|
requestTypes |
Type: SupplyRequestType[] 要过滤的请求类型。
Enum: Min items: Unique items |
|
sorting |
Type: SupplyRequestSortingDTO 排序参数。 |
SupplyRequestStatusType
送货请求状态:
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— 货物已准备好交货.
|
Type |
Description |
|
Enum: |
SupplyRequestSubType
应用程序子类型:
-
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— 当货物储存期届满时,出口订单中的货物自动处置.
|
Type |
Description |
|
Enum: |
SupplyRequestType
申请类别:
SUPPLY— 交付货物。WITHDRAW— 货物出口。UTILIZATION— 货物的处置。
|
Type |
Description |
|
Enum: |
SupplyRequestSortingDTO
排序参数。
|
Name |
Description |
|
attribute* |
Type: SupplyRequestSortAttributeType 按哪个参数对应用程序进行排序:
Enum: |
|
direction* |
Type: SortOrderType 分类方向:
Enum: |
SupplyRequestSortAttributeType
按哪个参数对应用程序进行排序:
-
ID— 的应用程序ID。 -
REQUESTED_DATE— 交付到存储仓库的日期。如果货物通过中转仓库,它会按两个仓库的交货日期对它们进行分类。
-
UPDATED_AT— 应用程序更新的时间。 -
STATUS— 应用程序的状态。
|
Type |
Description |
|
Enum: |
Responses
200 OK
应用程序列表及其信息。
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 |
|
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
|
result |
Type: GetSupplyRequestsDTO 应用程序列表及其信息。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
|
Type |
Description |
|
Enum: |
GetSupplyRequestsDTO
应用程序列表及其信息。
|
Name |
Description |
|
requests* |
Type: SupplyRequestDTO[] 的应用程序列表。 Min items: Max items: |
|
paging |
Type: ForwardScrollingPagerDTO 下一页的ID。 |
SupplyRequestDTO
送、移除或处置的请求的信息。
|
Name |
Description |
|
counters* |
Type: SupplyRequestCountersDTO Количество товаров, коробок и палет в заявке. |
|
id* |
Type: SupplyRequestIdDTO Идентификатор и номера заявки. |
|
status* |
Type: SupplyRequestStatusType 送货请求状态:
Enum: |
|
subtype* |
Type: SupplyRequestSubType 应用程序子类型:
Enum: |
|
targetLocation* |
Type: SupplyRequestLocationDTO Информация о складе хранения или ПВЗ. |
|
type* |
Type: SupplyRequestType 申请类别:
Enum: |
|
updatedAt* |
Type: string<date-time> 上次应用程序更新的日期和时间。 |
|
childrenLinks |
Type: SupplyRequestReferenceDTO[] 子应用程序的链接。 Min items: |
|
parentLink |
Type: SupplyRequestReferenceDTO Ссылка на родительскую заявку. |
|
transitLocation |
Type: SupplyRequestLocationDTO Информация о транзитном складе или ПВЗ. |
ForwardScrollingPagerDTO
下一页的ID。
|
Name |
Description |
|
nextPageToken |
Type: string 下一个结果页面的ID。 |
SupplyRequestCountersDTO
应用程序中的货物,箱子和托盘的数量。
|
Name |
Description |
|
acceptableCount |
Type: integer<int32> 可以额外携带的物品数量。 Min value: |
|
actualBoxCount |
Type: integer<int32> 仓库中接受的箱子数量。 Min value: |
|
actualPalletsCount |
Type: integer<int32> 仓库中接受的托盘数量。 Min value: |
|
defectCount |
Type: integer<int32> 次品的数量。 Min value: |
|
factCount |
Type: integer<int32> 仓库中接受的物料数量。 Min value: |
|
planCount |
Type: integer<int32> 交付请求中的项目数量。 Min value: |
|
shortageCount |
Type: integer<int32> 次品的数量。 Min value: |
|
surplusCount |
Type: integer<int32> 额外项目的数量。 Min value: |
|
unacceptableCount |
Type: integer<int32> 无法额外交付的项目数量。 Min value: |
|
undefinedCount |
Type: integer<int32> 拒收产品的数量。 Min value: |
SupplyRequestIdDTO
应用程序ID和编号。
|
Name |
Description |
|
id* |
Type: integer<int64> 的应用程序ID。 仅在API中使用 在市场上无法在卖方的帐户中找到应用程序。 要做到这一点,请使用 Min value: |
|
marketplaceRequestId |
Type: string 市场上的申请号。 它也在市场上的卖家账户中注明。 |
|
warehouseRequestId |
Type: string 仓库中的订单号。 它也在市场上的卖家账户中注明。 |
SupplyRequestLocationDTO
应用程序中有关仓库或PVZ的信息。
|
Name |
Description |
|
address* |
Type: SupplyRequestLocationAddressDTO 仓库或PVZ的地址。 |
|
name* |
Type: string 仓库或PVZ的名称。 |
|
serviceId* |
Type: integer<int64> PVZ的仓库或物流合作伙伴的ID。 |
|
type* |
Type: SupplyRequestLocationType 仓库或PVZ类型:
Enum: |
|
requestedDate |
Type: string<date-time> 交货到仓库或PVZ的日期和时间. |
SupplyRequestReferenceDTO
相关应用的信息。
|
Name |
Description |
|
id* |
Type: SupplyRequestIdDTO Идентификаторы связанной заявки. |
|
type* |
Type: SupplyRequestReferenceType Тип связи. Enum: |
SupplyRequestLocationAddressDTO
仓库或PVZ的地址。
|
Name |
Description |
|
fullAddress* |
Type: string 仓库或PVZ的完整地址。 |
|
gps* |
Type: GpsDTO 纬度和经度的GPS坐标。 |
SupplyRequestLocationType
仓库或PVZ类型:
FULFILLMENT— 仓储仓库。XDOC— 中转仓库。PICKUP_POINT— PVZ。
|
Type |
Description |
|
Enum: |
SupplyRequestReferenceType
两个应用程序之间的连接类型:
-
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.
|
Type |
Description |
|
Enum: |
GpsDTO
纬度和经度的GPS坐标。
|
Name |
Description |
|
latitude* |
Type: number 宽度。 |
|
longitude* |
Type: number 经度。 |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
ApiErrorDTO
一般错误格式。
|
Name |
Description |
|
code* |
Type: string 的错误代码。 |
|
message |
Type: string 错误的描述。 |
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
市场的内部错误。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.
阅读它在什么 燕基科斯.对卖家的市场帮助.