获取有关多个货件的信息

Info

Console

方法适用于模式FBS.

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

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

根据指定参数返回有关货件的信息:

日期。
状况;
订单Id。

结果逐页返回。

参数的限制 limit

不要传输大于30的值。

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

Request

PUT

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

活动ID。

您可以使用查询找到它 :no-translate[GET v2/campaigns] 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:

模块和 API→区块 向Yandex发送数据。街市.
查询日志 →块中的下拉列表 显示日志.

，不要发送商店ID，而不是，这是在卖方的帐户在市场上的商店名称旁边和一些报告。

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

每页的值数。

Min value: 1
Example: 20

page_token

Type: string

结果页面的ID。

如果省略该参数，则返回第一页。

我们建议传输输出参数的值 nextPageToken，在最后一次请求期间接收。

如果设置 page_token 并且请求有参数 page 和 pageSize 它们被忽略了。
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json

{
    "dateFrom": "string",
    "dateTo": "string",
    "statuses": [
        "OUTBOUND_CREATED"
    ],
    "orderIds": [
        0
    ],
    "cancelledOrders": true
}

Name	Description
dateFrom*	Type: string<date> 按发货日期（含）筛选的起始日期。日期格式: `DD-MM-YYYY`.
dateTo*	Type: string<date> 按发货日期（含）过滤的结束日期。日期格式: `DD-MM-YYYY`.
cancelledOrders	Type: boolean 是否退还已取消的订单。默认值: `true`. 如果您不需要退还已取消的订单，请传递价值 `false`. Default: `true`
orderIds	Type: integer<int64>[] 来自货件的订单Id列表。的订单ID。 Min items: `1` Unique items
statuses	Type: ShipmentStatusType[] 装运状态清单。 Статус отгрузки Enum: `OUTBOUND_CREATED`, `OUTBOUND_READY_FOR_CONFIRMATION`, `OUTBOUND_CONFIRMED`, `OUTBOUND_SIGNED`, `FINISHED`, `ACCEPTED`, `ACCEPTED_WITH_DISCREPANCIES`, `ERROR` Min items: `1` Unique items

ShipmentStatusType

付运情况:

OUTBOUND_CREATED -它正在形成。
OUTBOUND_READY_FOR_CONFIRMATION —它可以被处理。
OUTBOUND_CONFIRMED -确认并准备发货。
OUTBOUND_SIGNED -已签署电子验收证书。
ACCEPTED -在分拣中心或接收点接受。
ACCEPTED_WITH_DISCREPANCIES -接受与差异。
FINISHED -完成。
ERROR -因错误而取消。

Type	Description
ShipmentStatusType	Enum: `OUTBOUND_CREATED`, `OUTBOUND_READY_FOR_CONFIRMATION`, `OUTBOUND_CONFIRMED`, `OUTBOUND_SIGNED`, `FINISHED`, `ACCEPTED`, `ACCEPTED_WITH_DISCREPANCIES`, `ERROR`

Responses

200 OK

找到货件。

Body

application/json

{
    "status": "OK",
    "result": {
        "shipments": [
            {
                "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
                },
                "status": "OUTBOUND_CREATED",
                "statusDescription": "string",
                "statusUpdateTime": "2017-11-21T00:00:00+03:00"
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

result

Type: SearchShipmentsResponseDTO

有关货件的信息。

ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

SearchShipmentsResponseDTO

有关货件的信息。

Name

Description

shipments*

Type: ShipmentInfoDTO[]

包含有关货件信息的列表。
包含有关货件信息的列表。
航运信息。

paging

Type: ForwardScrollingPagerDTO

Страницы с результатами поиска.

ShipmentInfoDTO

包含有关货件信息的列表。

Name	Description
draftCount*	Type: integer<int32> 市场已安排装运的订单数量。 Min value: `0`
factCount*	Type: integer<int32> 在分拣中心或接收点接受的订单数量。 Min value: `0`
id*	Type: integer<int64> 装运ID。 Min value: `1`
orderIds*	Type: integer<int64>[] 货件中订单的Id。 Min value: `1` Unique items
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<int32> 市场已确认发货的订单数量。 Min value: `0`
signature*	Type: SignatureDTO 验收证书的签名的信息。
deliveryService	Type: DeliveryServiceDTO Служба доставки.
externalId	Type: string 系统中的货件ID。如果您还没有传递ID，则将返回参数中的ID。 `id`.
palletsCount	Type: PalletsCountDTO Данные о палетах в отгрузке.
shipmentType	Type: ShipmentType Способ отгрузки заказов. Enum: `IMPORT`, `WITHDRAW`
status	Type: ShipmentStatusType Статус отгрузки. Enum: `OUTBOUND_CREATED`, `OUTBOUND_READY_FOR_CONFIRMATION`, `OUTBOUND_CONFIRMED`, `OUTBOUND_SIGNED`, `FINISHED`, `ACCEPTED`, `ACCEPTED_WITH_DISCREPANCIES`, `ERROR`
statusDescription	Type: string 装运状态的描述。
statusUpdateTime	Type: string<date-time> 装运状态最后一次更改的时间日期格式: ISO 8601 具有相对于 UTC. Example: `2017-11-21T00:00:00+03:00`
warehouse	Type: PartnerShipmentWarehouseDTO Данные о складе отправления.
warehouseTo	Type: PartnerShipmentWarehouseDTO Данные о складе назначения.

ForwardScrollingPagerDTO

下一页的ID。

Name

Description

nextPageToken

Type: string

下一个结果页面的ID。

SignatureDTO

验收证书的签名的信息。

Name

Description

signed*

Type: boolean

验收证书是否已签署？

DeliveryServiceDTO

的送货服务。

Name

Description

Type: integer<int64>

送服务ID。

name

Type: string

送货服务的名称。

PalletsCountDTO

货件中的货盘数量。

Name

Description

fact

Type: integer<int32>

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

Min value: 0

planned

Type: integer<int32>

卖方指定的托盘数量。

Min value: 0

ShipmentType

订单的发货方式:

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

Type	Description
ShipmentType	Enum: `IMPORT`, `WITHDRAW`

PartnerShipmentWarehouseDTO

有关运输仓库的信息。

Name	Description
id*	Type: integer<int64> 发货仓库的ID。 Min value: `1`
address	Type: string 发货仓库的地址。
name	Type: string 装运仓库的名称。

400 Bad Request

请求包含不正确的数据。有关错误的更多信息

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

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

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

403 Forbidden

授权数据不正确或禁止访问资源。有关错误的更多信息

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

404 Not Found

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

420 Method Failure

已超出资源访问限制。有关错误的更多信息

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

500 Internal Server Error

Yandex中的内部错误。市场。有关错误的更多信息

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK -没有错误。
ERROR -处理请求时发生错误。

Enum: OK, ERROR

这篇文章是否有用？

有关单次装运的信息

验收及转让证明书