获取单个货件的信息

Info

Console

方法适用于模式FBS.

如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一

inventory-and-order-processing — 订单处理和商品核算
inventory-and-order-processing:read-only — 查看订单信息
all-methods — 全面管理账户
all-methods:read-only — 查看所有数据

按货件标识符返回有关货件的信息。

⚙️ 限制: 每小时100个请求

Request

GET

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/first-mile/shipments/{shipmentId}

Path parameters

Name

Description

campaignId

Type: integer

广告系列（商店）的ID — 通过API工作时，代表您在Yandex市场系统中的商店的技术标识符。它与您的商店唯一链接，但仅用于自动交互。

您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。点击您的帐户图标→ 设置在左边的菜单中，选择 Api和模块:

座 运动ID;
标签 查询日志 →块中的下拉列表 显示日志.

⚠️ 不要把它与:

商店的标识符，显示在商家的个人帐户中。
广告活动。

Min value: 1

shipmentId

Type: integer

装运ID。

Min value: 1

Query parameters

Name

Description

cancelledOrders

Type: boolean

是否退还已取消的订单。

默认值: true. 如果您不需要退还已取消的订单，请传递价值 false.

Default: true

Responses

200 OK

找到的货物。

Body

application/json

{
  "status": "OK",
  "result": {
    "id": 1,
    "planIntervalFrom": "2017-11-21T00:00:00+03:00",
    "planIntervalTo": "2017-11-21T00:00:00+03:00",
    "shipmentType": "IMPORT",
    "warehouse": {
      "id": 1,
      "name": "example",
      "address": "example"
    },
    "warehouseTo": {
      "id": 1,
      "name": "example",
      "address": "example"
    },
    "externalId": "example",
    "deliveryService": {
      "id": 0,
      "name": "example"
    },
    "palletsCount": {
      "planned": 0,
      "fact": 0
    },
    "orderIds": [
      1
    ],
    "draftCount": 0,
    "plannedCount": 0,
    "factCount": 0,
    "signature": {
      "signed": true
    },
    "currentStatus": {
      "status": "OUTBOUND_CREATED",
      "description": "example",
      "updateTime": "2017-11-21T00:00:00+03:00"
    },
    "availableActions": [
      "CONFIRM"
    ]
  }
}

Type: object

All of 2 types

Type: object
status

Type: string

响应的类型。可能的值:

OK — 没有错误。

ERROR — 处理请求时出错。

Enum: OK, ERROR
服务器响应的标准包装器。
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

All of 2 types

Type: object

draftCount

Type: integer

市场已安排装运的订单数量。

Min value: 0

factCount

Type: integer

在分拣中心或接收点接受的订单数量。

Min value: 0

Type: integer

装运ID。

Min value: 1

orderIds

Type: integer[]

货件中订单的Id。

Unique items: true

Example

[
  1
]

planIntervalFrom

Type: string<date-time>

预定运输间隔的开始。

日期格式: ISO 8601 具有相对于 UTC.

Example: 2017-11-21T00:00:00+03:00

planIntervalTo

Type: string<date-time>

计划装运间隔的结束。

日期格式: ISO 8601 具有相对于 UTC.

Example: 2017-11-21T00:00:00+03:00

plannedCount

Type: integer

市场已确认发货的订单数量。

Min value: 0

signature

Type: object

signed

Type: boolean

验收证书是否已签署？

验收证书的签名的信息。

Example

{
  "signed": true
}

deliveryService

Type: object

Type: integer

送服务ID。

name

Type: string

送货服务的名称。

Example: example

的送货服务。

Example

{
  "id": 0,
  "name": "example"
}

externalId

Type: string

系统中的货件ID。如果您还没有传递ID，则将返回参数中的ID。 id.

Example: example

palletsCount

Type: object

fact

Type: integer

分拣中心接受的托盘数量。

Min value: 0

planned

Type: integer

卖方指定的托盘数量。

Min value: 0

货件中的货盘数量。

Example

{
  "planned": 0,
  "fact": 0
}

shipmentType

Type: string

订单的发货方式:

IMPORT — 您可以自行将订单带到选定的分拣中心或订单受理点。
WITHDRAW — 您将订单从仓库运送到Yandex市场快递员。

Enum: IMPORT, WITHDRAW

warehouse

Type: object

Type: integer

发货仓库的ID。

Min value: 1

address

Type: string

发货仓库的地址。

Example: example

name

Type: string

装运仓库的名称。

Example: example

有关运输仓库的信息。

Example

{
  "id": 1,
  "name": "example",
  "address": "example"
}

warehouseTo

Type: object

Type: integer

发货仓库的ID。

Min value: 1

address

Type: string

发货仓库的地址。

Example: example

name

Type: string

装运仓库的名称。

Example: example

有关运输仓库的信息。

Example

{
  "id": 1,
  "name": "example",
  "address": "example"
}

航运信息。

Example

{
  "id": 1,
  "planIntervalFrom": "2017-11-21T00:00:00+03:00",
  "planIntervalTo": "2017-11-21T00:00:00+03:00",
  "shipmentType": "IMPORT",
  "warehouse": {
    "id": 1,
    "name": "example",
    "address": "example"
  },
  "warehouseTo": {
    "id": 1,
    "name": "example",
    "address": "example"
  },
  "externalId": "example",
  "deliveryService": {
    "id": 0,
    "name": "example"
  },
  "palletsCount": {
    "planned": 0,
    "fact": 0
  },
  "orderIds": [
    1
  ],
  "draftCount": 0,
  "plannedCount": 0,
  "factCount": 0,
  "signature": {
    "signed": true
  }
}

Type: object

availableActions

Type: string[]

货件上可用的操作。

Unique items: true

Example

[
  "CONFIRM"
]

currentStatus

Type: object

description

Type: string

装运状态的描述。

Example: example

status

Type: string

付运情况:

OUTBOUND_CREATED — 它正在形成。
OUTBOUND_READY_FOR_CONFIRMATION — 它可以被处理。
OUTBOUND_CONFIRMED — 确认并准备装运。
OUTBOUND_SIGNED — 已为其签署电子验收证书。
ACCEPTED — 在分拣中心或接收点接受。
ACCEPTED_WITH_DISCREPANCIES — 接受有差异。
FINISHED — 完成了。
ERROR — 由于错误而取消。

Enum: OUTBOUND_CREATED, OUTBOUND_READY_FOR_CONFIRMATION, OUTBOUND_CONFIRMED, OUTBOUND_SIGNED, FINISHED, ACCEPTED, ACCEPTED_WITH_DISCREPANCIES, ERROR

updateTime

Type: string<date-time>

装运状态上一次更改的时间。

日期格式: ISO 8601 具有相对于 UTC.

Example: 2017-11-21T00:00:00+03:00

装运状态。

Example

{
  "status": "OUTBOUND_CREATED",
  "description": "example",
  "updateTime": "2017-11-21T00:00:00+03:00"
}

航运信息。

Example

{
  "currentStatus": {
    "status": "OUTBOUND_CREATED",
    "description": "example",
    "updateTime": "2017-11-21T00:00:00+03:00"
  },
  "availableActions": [
    "CONFIRM"
  ]
}

航运信息。

Example

{
  "id": 1,
  "planIntervalFrom": "2017-11-21T00:00:00+03:00",
  "planIntervalTo": "2017-11-21T00:00:00+03:00",
  "shipmentType": "IMPORT",
  "warehouse": {
    "id": 1,
    "name": "example",
    "address": "example"
  },
  "warehouseTo": {
    "id": 1,
    "name": "example",
    "address": "example"
  },
  "externalId": "example",
  "deliveryService": {
    "id": 0,
    "name": "example"
  },
  "palletsCount": {
    "planned": 0,
    "fact": 0
  },
  "orderIds": [
    1
  ],
  "draftCount": 0,
  "plannedCount": 0,
  "factCount": 0,
  "signature": {
    "signed": true
  },
  "currentStatus": {
    "status": "OUTBOUND_CREATED",
    "description": "example",
    "updateTime": "2017-11-21T00:00:00+03:00"
  },
  "availableActions": [
    "CONFIRM"
  ]
}

Example

{
  "result": {
    "id": 1,
    "planIntervalFrom": "2017-11-21T00:00:00+03:00",
    "planIntervalTo": "2017-11-21T00:00:00+03:00",
    "shipmentType": "IMPORT",
    "warehouse": {
      "id": 1,
      "name": "example",
      "address": "example"
    },
    "warehouseTo": {
      "id": 1,
      "name": "example",
      "address": "example"
    },
    "externalId": "example",
    "deliveryService": {
      "id": 0,
      "name": "example"
    },
    "palletsCount": {
      "planned": 0,
      "fact": 0
    },
    "orderIds": [
      1
    ],
    "draftCount": 0,
    "plannedCount": 0,
    "factCount": 0,
    "signature": {
      "signed": true
    },
    "currentStatus": {
      "status": "OUTBOUND_CREATED",
      "description": "example",
      "updateTime": "2017-11-21T00:00:00+03:00"
    },
    "availableActions": [
      "CONFIRM"
    ]
  }
}

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: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

[
  {
    "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: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

[
  {
    "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: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

服务器错误的标准包装器。

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

404 Not Found

找不到请求的资源。有关错误的更多信息

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: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

[
  {
    "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: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

[
  {
    "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: example

message

Type: string

错误的描述。

Example: example

错误列表。

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

服务器错误的标准包装器。

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

这篇文章是否有用？

有关文件的资料

有关多个货件的资料