Getting information about a single shipment

Info

Console

The method is available for the FBS model.

If you are using an API Key token, one of the accesses in the list is required to call the method

inventory-and-order-processing — Order processing and inventory
inventory-and-order-processing:read-only — View order information
all-methods — Full account management
all-methods:read-only — View all data

Returns information about the shipment by its identifier.

⚙️ Limit: 100 requests per hour

Request

GET

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

Path parameters

Name

Description

campaignId

Type: integer

The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:

block Campaign ID;
tab Query log → drop-down list in the block Show logs.

⚠️ Do not confuse it with:

the store's identifier, which is displayed in the merchant's personal account.
advertising campaigns.

Min value: 1

shipmentId

Type: integer

Shipment ID.

Min value: 1

Query parameters

Name

Description

cancelledOrders

Type: boolean

Whether to refund cancelled orders.

Default value: true. If you do not need to refund cancelled orders, pass the value false.

Default: true

Responses

200 OK

The found shipment.

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

All of 2 types

Type: object

draftCount

Type: integer

The number of orders that the Market has scheduled for shipment.

Min value: 0

factCount

Type: integer

The number of orders accepted at the sorting center or reception point.

Min value: 0

Type: integer

Shipment ID.

Min value: 1

orderIds

Type: integer[]

The IDs of the orders in the shipment.

Unique items: true

Example

[
  1
]

planIntervalFrom

Type: string<date-time>

The beginning of the scheduled shipping interval.

Date format: ISO 8601 with an offset relative to UTC.

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

planIntervalTo

Type: string<date-time>

The end of the planned shipping interval.

Date format: ISO 8601 with an offset relative to UTC.

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

plannedCount

Type: integer

The number of orders that the Market has confirmed for shipment.

Min value: 0

signature

Type: object

signed

Type: boolean

Has the acceptance certificate been signed?

Information about the signature of the acceptance certificate.

Example

{
  "signed": true
}

deliveryService

Type: object

Type: integer

The delivery service ID.

name

Type: string

The name of the delivery service.

Example: example

The delivery service.

Example

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

externalId

Type: string

The shipment ID in your system. If you haven't passed the ID yet, the ID from the parameter will be returned. id.

Example: example

palletsCount

Type: object

fact

Type: integer

The number of pallets accepted at the sorting center.

Min value: 0

planned

Type: integer

The number of pallets specified by the seller.

Min value: 0

The number of pallets in the shipment.

Example

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

shipmentType

Type: string

Shipping method of orders:

IMPORT — You bring your orders to the selected sorting center or order acceptance point on your own.
WITHDRAW — you ship orders from your warehouse to Yandex Market couriers.

Enum: IMPORT, WITHDRAW

warehouse

Type: object

Type: integer

The ID of the shipping warehouse.

Min value: 1

address

Type: string

The address of the shipping warehouse.

Example: example

name

Type: string

The name of the shipping warehouse.

Example: example

Information about the shipping warehouse.

Example

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

warehouseTo

Type: object

Type: integer

The ID of the shipping warehouse.

Min value: 1

address

Type: string

The address of the shipping warehouse.

Example: example

name

Type: string

The name of the shipping warehouse.

Example: example

Information about the shipping warehouse.

Example

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

Shipping information.

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[]

Available actions on the shipment.

Unique items: true

Example

[
  "CONFIRM"
]

currentStatus

Type: object

description

Type: string

Description of the shipment status.

Example: example

status

Type: string

Shipment status:

OUTBOUND_CREATED — It is being formed.
OUTBOUND_READY_FOR_CONFIRMATION — it can be processed.
OUTBOUND_CONFIRMED — confirmed and ready to ship.
OUTBOUND_SIGNED — An electronic acceptance certificate has been signed for it.
ACCEPTED — accepted at the sorting center or reception point.
ACCEPTED_WITH_DISCREPANCIES — accepted with discrepancies.
FINISHED — completed.
ERROR — cancelled due to an error.

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

updateTime

Type: string<date-time>

The time of the last change in the shipment status.

Date format: ISO 8601 with an offset relative to UTC.

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

Shipment status.

Example

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

Shipping information.

Example

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

Shipping information.

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

The request contains incorrect data. More information about the error

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

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

Example

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

A standard wrapper for server errors.

Example

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

401 Unauthorized

The authorization data is not specified in the request. More information about the error

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

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

Example

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

A standard wrapper for server errors.

Example

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

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

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

Example

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

A standard wrapper for server errors.

Example

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

404 Not Found

The requested resource was not found. More information about the error

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

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

Example

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

A standard wrapper for server errors.

Example

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

420 Method Failure

The resource access limit has been exceeded. More information about the error

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

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

Example

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

A standard wrapper for server errors.

Example

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

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

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

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

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

Example

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

A standard wrapper for server errors.

Example

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

Was the article helpful?

Information about documents

Information about multiple shipments