获取有关单次装运的信息
方法适用于模式FBS.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
按货件标识符返回有关货件的信息。
**⚙️ 限制:**每小时100个请求 |
---|
Request
GET
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/first-mile/shipments/{shipmentId}
Path parameters
Name |
Description |
campaignId* |
Type: integer<int64> 活动ID。 您可以使用查询找到它 :no-translate[GET v2/campaigns] 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。
Min value: |
shipmentId* |
Type: integer<int64> 装运ID。 Min value: |
Query parameters
Name |
Description |
cancelledOrders |
Type: boolean 是否退还已取消的订单。 默认值: Default: |
Responses
200 OK
找到的货物。
Body
application/json
{
"status": "OK",
"result": {
"id": 0,
"planIntervalFrom": "2017-11-21T00:00:00+03:00",
"planIntervalTo": "2017-11-21T00:00:00+03:00",
"shipmentType": "IMPORT",
"warehouse": {
"id": 0,
"name": "string",
"address": "string"
},
"warehouseTo": {
"id": 0,
"name": "string",
"address": "string"
},
"externalId": "string",
"deliveryService": {
"id": 0,
"name": "string"
},
"palletsCount": {
"planned": 0,
"fact": 0
},
"orderIds": [
0
],
"draftCount": 0,
"plannedCount": 0,
"factCount": 0,
"signature": {
"signed": false
},
"currentStatus": {
"status": "OUTBOUND_CREATED",
"description": "string",
"updateTime": "2017-11-21T00:00:00+03:00"
},
"availableActions": [
"CONFIRM"
]
}
}
Name |
Description |
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
result |
Type: ShipmentDTO 航运信息。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK
-没有错误。ERROR
-处理请求时发生错误。
Type |
Description |
Enum: |
ShipmentDTO
航运信息。
Name |
Description |
availableActions* |
Type: ShipmentActionType[] 货件上可用的操作。
Enum: Unique items |
draftCount* |
Type: integer<int32> 市场已安排装运的订单数量。 Min value: |
factCount* |
Type: integer<int32> 在分拣中心或接收点接受的订单数量。 Min value: |
id* |
Type: integer<int64> 装运ID。 Min value: |
orderIds* |
Type: integer<int64>[] 货件中订单的Id。 Min value: Unique items |
planIntervalFrom* |
Type: string<date-time> 预定运输间隔的开始。 日期格式: ISO 8601 具有相对于 UTC. Example: |
planIntervalTo* |
Type: string<date-time> 计划装运间隔的结束。 日期格式: ISO 8601 具有相对于 UTC. Example: |
plannedCount* |
Type: integer<int32> 市场已确认发货的订单数量。 Min value: |
signature* |
Type: SignatureDTO 验收证书的签名的信息。 |
currentStatus |
Type: ShipmentStatusChangeDTO Статус отгрузки. |
deliveryService |
Type: DeliveryServiceDTO Служба доставки. |
externalId |
Type: string 系统中的货件ID。 如果您还没有传递ID,则将返回参数中的ID。 |
palletsCount |
Type: PalletsCountDTO Данные о палетах в отгрузке. |
shipmentType |
Type: ShipmentType Способ отгрузки заказов. Enum: |
warehouse |
Type: PartnerShipmentWarehouseDTO Данные о складе отправления. |
warehouseTo |
Type: PartnerShipmentWarehouseDTO Данные о складе назначения. |
ShipmentActionType
航运行动:
CONFIRM
-确认装运。DOWNLOAD_ACT
-下载装运验收和转移证书。DOWNLOAD_INBOUND_ACT
-下载已接受订单列表。DOWNLOAD_DISCREPANCY_ACT
-下载差异的行为。DOWNLOAD_TRANSPORTATION_WAYBILL
-下载提单。CHANGE_PALLETS_COUNT
-指定托盘的数量。
Type |
Description |
Enum: |
SignatureDTO
验收证书的签名的信息。
Name |
Description |
signed* |
Type: boolean 验收证书是否已签署? |
ShipmentStatusChangeDTO
装运状态。
Name |
Description |
description |
Type: string 装运状态的描述。 |
status |
Type: ShipmentStatusType Статус отгрузки. Enum: |
updateTime |
Type: string<date-time> 装运状态上一次更改的时间。 日期格式: ISO 8601 具有相对于 UTC. Example: |
DeliveryServiceDTO
的送货服务。
Name |
Description |
id |
Type: integer<int64> 送服务ID。 |
name |
Type: string 送货服务的名称。 |
PalletsCountDTO
货件中的货盘数量。
Name |
Description |
fact |
Type: integer<int32> 分拣中心接受的托盘数量。 Min value: |
planned |
Type: integer<int32> 卖方指定的托盘数量。 Min value: |
ShipmentType
订单的发货方式:
IMPORT
—您自行将订单带到选定的分拣中心或订单受理点。WITHDRAW
—您将订单从仓库运送到Yandex市场快递员。
Type |
Description |
Enum: |
PartnerShipmentWarehouseDTO
有关运输仓库的信息。
Name |
Description |
id* |
Type: integer<int64> 发货仓库的ID。 Min value: |
address |
Type: string 发货仓库的地址。 |
name |
Type: string 装运仓库的名称。 |
ShipmentStatusType
付运情况:
OUTBOUND_CREATED
-它正在形成。OUTBOUND_READY_FOR_CONFIRMATION
—它可以被处理。OUTBOUND_CONFIRMED
-确认并准备发货。OUTBOUND_SIGNED
-已签署电子验收证书。ACCEPTED
-在分拣中心或接收点接受。ACCEPTED_WITH_DISCREPANCIES
-接受与差异。FINISHED
-完成。ERROR
-因错误而取消。
Type |
Description |
Enum: |
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: |
404 Not Found
找不到请求的资源。 有关错误的更多信息
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
Yandex中的内部错误。 市场。 有关错误的更多信息
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.