---
metadata:
  - name: generator
    content: Diplodoc Platform v5.55.0
alternate:
  - https://yandex.com/dev/market/partner-api/doc/en/reference/shipments/getShipment.md
  - https://yandex.com/dev/market/partner-api/doc/ru/reference/shipments/getShipment.md
  - https://yandex.com/dev/market/partner-api/doc/zh/reference/shipments/getShipment.md
  - href: en/reference/shipments/getShipment.md
    type: text/markdown
    title: Markdown version
  - href: ../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/market/partner-api/doc/en/llms.txt

<!-- source: en/api/shipments/getShipment.md -->
<div class="openapi">

# Getting information about a single shipment

<!-- markdownlint-disable-file -->

{% list tabs %}

- Info

  
  <!-- source: en/_auto/method_scopes/getShipment.md -->
  **The method is available for the [FBS](https://yandex.com/dev/market/partner-api/doc/en/overview/fbs.md) model.**

  {% cut "**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](https://yandex.com/dev/market/partner-api/doc/en/_auto/scopes_summary/pages/inventory-and-order-processing.md)
  * inventory-and-order-processing:read-only — [View order information](https://yandex.com/dev/market/partner-api/doc/en/_auto/scopes_summary/pages/inventory-and-order-processing_read-only.md)
  * all-methods — Full account management
  * all-methods:read-only — View all data

  {% endcut %}
  <!-- endsource: en/_auto/method_scopes/getShipment.md -->
  
  
  Returns information about the shipment by its identifier.
  
  
  <!-- source: en/_auto/method_limits/getShipment.md -->
  |<div style="text-align: left;">**⚙️ Limit:** 200 requests per hour</div>|
  |-|
  <!-- endsource: en/_auto/method_limits/getShipment.md -->
  
  
  
  ## Request
  
  <div class="openapi__requests">
  
  <div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-get);margin-bottom: 12px">
  
  <div class="openapi__request">
  
  GET {.openapi__method}
  ```text translate=no
  https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/first-mile/shipments/{shipmentId}
  ```
  
  </div>
  
  </div>
  
  </div>
  
  ### Path parameters
  
  #|
  || **Name** | **Description** ||
  ||
  
  _campaignId_{.json-schema-reset .json-schema-property .json-schema-required}
  {.table-cell}|
  **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](https://yandex.com/dev/market/partner-api/doc/en/reference/campaigns/getCampaigns.md) 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:_{.json-schema-reset .json-schema-assertion} `1`
  {.table-cell}
  ||
  ||
  
  _shipmentId_{.json-schema-reset .json-schema-property .json-schema-required}
  {.table-cell}|
  **Type**: integer
  
  Shipment ID.
  
  _Min value:_{.json-schema-reset .json-schema-assertion} `1`
  {.table-cell}
  ||
  |#{.json-schema-properties}
  
  ### Query parameters
  
  #|
  || **Name** | **Description** ||
  ||
  
  _cancelledOrders_{.json-schema-reset .json-schema-property}
  {.table-cell}|
  **Type**: boolean
  
  Whether to refund cancelled orders.
  
  Default value: `true`. If you do not need to refund cancelled orders, pass the value `false`.
  
  
  _Default:_{.json-schema-reset .json-schema-value} `true`
  {.table-cell}
  ||
  |#{.json-schema-properties}
  
  ## Responses
  
  <div class="openapi__response__code__200">
  
  ## 200 OK
  
  The found shipment.
  
  <div class="openapi-entity">
  
  ### Body
  
  {% cut "application/json" %}
  
  ```json translate=no
  {
    "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"
      ]
    }
  }
  ```
  
  {% endcut %}
  
  **Type**: object
  
  {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
  
  - {% cut "**Type**: object" %}
  
    #|
    ||
  
    _status_{.json-schema-reset .json-schema-property .json-schema-required}
    {.table-cell}|
    **Type**: string
  
    The type of response.
    Possible values:
    * `OK` — There are no errors.
    * `ERROR` — an error occurred while processing the request.
  
  
    _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
    {.table-cell}
    ||
    |#{.json-schema-properties}
  
    {% endcut %}
  
    The standard wrapper for server responses.
  
    {% cut "**Example**" %}{.json-schema-example}
  
    ```json translate=no
    {
      "status": "OK"
    }
    ```
  
    {% endcut %}
  
  - {% cut "**Type**: object" %}
  
    #|
    ||
  
    _result_{.json-schema-reset .json-schema-property}
    {.table-cell}|
    **Type**: object
  
    {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
  
    - **Type**: object
  
      #|
      ||
  
      _draftCount_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: integer
  
      The number of orders that the Market has scheduled for shipment.
  
      _Min value:_{.json-schema-reset .json-schema-assertion} `0`
      {.table-cell}
      ||
      ||
  
      _factCount_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: integer
  
      The number of orders accepted at the sorting center or reception point.
  
      _Min value:_{.json-schema-reset .json-schema-assertion} `0`
      {.table-cell}
      ||
      ||
  
      _id_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: integer
  
      Shipment ID.
  
      _Min value:_{.json-schema-reset .json-schema-assertion} `1`
      {.table-cell}
      ||
      ||
  
      _orderIds_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: integer[]
  
      The IDs of the orders in the shipment.
  
      _Unique items:_{.json-schema-reset .json-schema-assertion} `true`
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      [
        1
      ]
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      ||
  
      _planIntervalFrom_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string&lt;date-time&gt;
  
      The beginning of the scheduled shipping interval.
  
      Date format: ISO 8601 with an offset relative to UTC.
  
  
      _Example:_{.json-schema-reset .json-schema-example} `2017-11-21T00:00:00+03:00`
      {.table-cell}
      ||
      ||
  
      _planIntervalTo_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string&lt;date-time&gt;
  
      The end of the planned shipping interval.
  
      Date format: ISO 8601 with an offset relative to UTC.
  
  
      _Example:_{.json-schema-reset .json-schema-example} `2017-11-21T00:00:00+03:00`
      {.table-cell}
      ||
      ||
  
      _plannedCount_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: integer
  
      The number of orders that the Market has confirmed for shipment.
  
      _Min value:_{.json-schema-reset .json-schema-assertion} `0`
      {.table-cell}
      ||
      ||
  
      _signature_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      {% cut "**Type**: object" %}
  
      #|
      ||
  
      _signed_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: boolean
  
      Has the acceptance certificate been signed?
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% endcut %}
  
      Information about the signature of the acceptance certificate.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "signed": true
      }
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      ||
  
      _deliveryService_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      {% cut "**Type**: object" %}
  
      #|
      ||
  
      _id_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: integer
  
      The delivery service ID.
      {.table-cell}
      ||
      ||
  
      _name_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string
  
      The name of the delivery service.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% endcut %}
  
      The delivery service.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "id": 0,
        "name": "example"
      }
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      ||
  
      _externalId_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **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:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      ||
  
      _palletsCount_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      {% cut "**Type**: object" %}
  
      #|
      ||
  
      _fact_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: integer
  
      The number of pallets accepted at the sorting center.
  
      _Min value:_{.json-schema-reset .json-schema-assertion} `0`
      {.table-cell}
      ||
      ||
  
      _planned_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: integer
  
      The number of pallets specified by the seller.
  
      _Min value:_{.json-schema-reset .json-schema-assertion} `0`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% endcut %}
  
      The number of pallets in the shipment.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "planned": 0,
        "fact": 0
      }
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      ||
  
      _shipmentType_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **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:_{.json-schema-reset .json-schema-value} `IMPORT`, `WITHDRAW`
      {.table-cell}
      ||
      ||
  
      _warehouse_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      {% cut "**Type**: object" %}
  
      #|
      ||
  
      _id_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: integer
  
      The ID of the shipping warehouse.
  
      _Min value:_{.json-schema-reset .json-schema-assertion} `1`
      {.table-cell}
      ||
      ||
  
      _address_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string
  
      The address of the shipping warehouse.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      ||
  
      _name_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string
  
      The name of the shipping warehouse.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% endcut %}
  
      Information about the shipping warehouse.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "id": 1,
        "name": "example",
        "address": "example"
      }
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      ||
  
      _warehouseTo_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      {% cut "**Type**: object" %}
  
      #|
      ||
  
      _id_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: integer
  
      The ID of the shipping warehouse.
  
      _Min value:_{.json-schema-reset .json-schema-assertion} `1`
      {.table-cell}
      ||
      ||
  
      _address_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string
  
      The address of the shipping warehouse.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      ||
  
      _name_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string
  
      The name of the shipping warehouse.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% endcut %}
  
      Information about the shipping warehouse.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "id": 1,
        "name": "example",
        "address": "example"
      }
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      Shipping information.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "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
        }
      }
      ```
  
      {% endcut %}
  
    - **Type**: object
  
      #|
      ||
  
      _availableActions_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string[]
  
      Available actions on the shipment.
  
      _Unique items:_{.json-schema-reset .json-schema-assertion} `true`
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      [
        "CONFIRM"
      ]
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      ||
  
      _currentStatus_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      {% cut "**Type**: object" %}
  
      #|
      ||
  
      _description_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string
  
      Description of the shipment status.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      ||
  
      _status_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **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:_{.json-schema-reset .json-schema-value} `OUTBOUND_CREATED`, `OUTBOUND_READY_FOR_CONFIRMATION`, `OUTBOUND_CONFIRMED`, `OUTBOUND_SIGNED`, `FINISHED`, `ACCEPTED`, `ACCEPTED_WITH_DISCREPANCIES`, `ERROR`
      {.table-cell}
      ||
      ||
  
      _updateTime_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string&lt;date-time&gt;
  
      The time of the last change in the shipment status.
  
      Date format: ISO 8601 with an offset relative to UTC.
  
  
      _Example:_{.json-schema-reset .json-schema-example} `2017-11-21T00:00:00+03:00`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% endcut %}
  
      Shipment status.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "status": "OUTBOUND_CREATED",
        "description": "example",
        "updateTime": "2017-11-21T00:00:00+03:00"
      }
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      Shipping information.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "currentStatus": {
          "status": "OUTBOUND_CREATED",
          "description": "example",
          "updateTime": "2017-11-21T00:00:00+03:00"
        },
        "availableActions": [
          "CONFIRM"
        ]
      }
      ```
  
      {% endcut %}
  
    {% endcut %}
  
    Shipping information.
  
    {% cut "**Example**" %}{.json-schema-example}
  
    ```json translate=no
    {
      "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"
      ]
    }
    ```
  
    {% endcut %}
    {.table-cell}
    ||
    |#{.json-schema-properties}
  
    {% endcut %}
  
    {% cut "**Example**" %}{.json-schema-example}
  
    ```json translate=no
    {
      "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"
        ]
      }
    }
    ```
  
    {% endcut %}
  
  {% endcut %}
  
  </div>
  
  </div>
  
  <div class="openapi__response__code__400">
  
  ## 400 Bad Request
  
  The request contains incorrect data. [More information about the error](https://yandex.com/dev/market/partner-api/doc/en/concepts/error-codes.md#400)
  
  <div class="openapi-entity">
  
  ### Body
  
  {% cut "application/json" %}
  
  ```json translate=no
  {
    "status": "OK",
    "errors": [
      {
        "code": "example",
        "message": "example"
      }
    ]
  }
  ```
  
  {% endcut %}
  
  **Type**: object
  
  {% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}
  
  - **Type**: object
  
    {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
  
    - **Type**: object
  
      #|
      ||
  
      _status_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string
  
      The type of response.
      Possible values:
      * `OK` — There are no errors.
      * `ERROR` — an error occurred while processing the request.
  
  
      _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      The standard wrapper for server responses.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "status": "OK"
      }
      ```
  
      {% endcut %}
  
    - **Type**: object
  
      #|
      ||
  
      _errors_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      {% cut "**Type**: object[]" %}
  
      #|
      ||
  
      _code_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string
  
      The error code.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      ||
  
      _message_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string
  
      Description of the error.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% endcut %}
  
      A list of errors.
  
      _Min items:_{.json-schema-reset .json-schema-assertion} `1`
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      ```
  
      {% endcut %}
  
    {% endcut %}
  
    A standard wrapper for server errors.
  
    {% cut "**Example**" %}{.json-schema-example}
  
    ```json translate=no
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    ```
  
    {% endcut %}
  
  {% endcut %}
  
  </div>
  
  </div>
  
  <div class="openapi__response__code__401">
  
  ## 401 Unauthorized
  
  The authorization data is not specified in the request. [More information about the error](https://yandex.com/dev/market/partner-api/doc/en/concepts/error-codes.md#401)
  
  <div class="openapi-entity">
  
  ### Body
  
  {% cut "application/json" %}
  
  ```json translate=no
  {
    "status": "OK",
    "errors": [
      {
        "code": "example",
        "message": "example"
      }
    ]
  }
  ```
  
  {% endcut %}
  
  **Type**: object
  
  {% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}
  
  - **Type**: object
  
    {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
  
    - **Type**: object
  
      #|
      ||
  
      _status_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string
  
      The type of response.
      Possible values:
      * `OK` — There are no errors.
      * `ERROR` — an error occurred while processing the request.
  
  
      _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      The standard wrapper for server responses.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "status": "OK"
      }
      ```
  
      {% endcut %}
  
    - **Type**: object
  
      #|
      ||
  
      _errors_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      {% cut "**Type**: object[]" %}
  
      #|
      ||
  
      _code_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string
  
      The error code.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      ||
  
      _message_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string
  
      Description of the error.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% endcut %}
  
      A list of errors.
  
      _Min items:_{.json-schema-reset .json-schema-assertion} `1`
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      ```
  
      {% endcut %}
  
    {% endcut %}
  
    A standard wrapper for server errors.
  
    {% cut "**Example**" %}{.json-schema-example}
  
    ```json translate=no
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    ```
  
    {% endcut %}
  
  {% endcut %}
  
  </div>
  
  </div>
  
  <div class="openapi__response__code__403">
  
  ## 403 Forbidden
  
  The authorization data is incorrect or access to the resource is prohibited. [More information about the error](https://yandex.com/dev/market/partner-api/doc/en/concepts/error-codes.md#403)
  
  <div class="openapi-entity">
  
  ### Body
  
  {% cut "application/json" %}
  
  ```json translate=no
  {
    "status": "OK",
    "errors": [
      {
        "code": "example",
        "message": "example"
      }
    ]
  }
  ```
  
  {% endcut %}
  
  **Type**: object
  
  {% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}
  
  - **Type**: object
  
    {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
  
    - **Type**: object
  
      #|
      ||
  
      _status_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string
  
      The type of response.
      Possible values:
      * `OK` — There are no errors.
      * `ERROR` — an error occurred while processing the request.
  
  
      _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      The standard wrapper for server responses.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "status": "OK"
      }
      ```
  
      {% endcut %}
  
    - **Type**: object
  
      #|
      ||
  
      _errors_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      {% cut "**Type**: object[]" %}
  
      #|
      ||
  
      _code_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string
  
      The error code.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      ||
  
      _message_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string
  
      Description of the error.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% endcut %}
  
      A list of errors.
  
      _Min items:_{.json-schema-reset .json-schema-assertion} `1`
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      ```
  
      {% endcut %}
  
    {% endcut %}
  
    A standard wrapper for server errors.
  
    {% cut "**Example**" %}{.json-schema-example}
  
    ```json translate=no
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    ```
  
    {% endcut %}
  
  {% endcut %}
  
  </div>
  
  </div>
  
  <div class="openapi__response__code__404">
  
  ## 404 Not Found
  
  The requested resource was not found. [More information about the error](https://yandex.com/dev/market/partner-api/doc/en/concepts/error-codes.md#404)
  
  <div class="openapi-entity">
  
  ### Body
  
  {% cut "application/json" %}
  
  ```json translate=no
  {
    "status": "OK",
    "errors": [
      {
        "code": "example",
        "message": "example"
      }
    ]
  }
  ```
  
  {% endcut %}
  
  **Type**: object
  
  {% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}
  
  - **Type**: object
  
    {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
  
    - **Type**: object
  
      #|
      ||
  
      _status_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string
  
      The type of response.
      Possible values:
      * `OK` — There are no errors.
      * `ERROR` — an error occurred while processing the request.
  
  
      _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      The standard wrapper for server responses.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "status": "OK"
      }
      ```
  
      {% endcut %}
  
    - **Type**: object
  
      #|
      ||
  
      _errors_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      {% cut "**Type**: object[]" %}
  
      #|
      ||
  
      _code_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string
  
      The error code.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      ||
  
      _message_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string
  
      Description of the error.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% endcut %}
  
      A list of errors.
  
      _Min items:_{.json-schema-reset .json-schema-assertion} `1`
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      ```
  
      {% endcut %}
  
    {% endcut %}
  
    A standard wrapper for server errors.
  
    {% cut "**Example**" %}{.json-schema-example}
  
    ```json translate=no
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    ```
  
    {% endcut %}
  
  {% endcut %}
  
  </div>
  
  </div>
  
  <div class="openapi__response__code__420">
  
  ## 420 Method Failure
  
  The resource access limit has been exceeded. [More information about the error](https://yandex.com/dev/market/partner-api/doc/en/concepts/error-codes.md#420)
  
  <div class="openapi-entity">
  
  ### Body
  
  {% cut "application/json" %}
  
  ```json translate=no
  {
    "status": "OK",
    "errors": [
      {
        "code": "example",
        "message": "example"
      }
    ]
  }
  ```
  
  {% endcut %}
  
  **Type**: object
  
  {% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}
  
  - **Type**: object
  
    {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
  
    - **Type**: object
  
      #|
      ||
  
      _status_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string
  
      The type of response.
      Possible values:
      * `OK` — There are no errors.
      * `ERROR` — an error occurred while processing the request.
  
  
      _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      The standard wrapper for server responses.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "status": "OK"
      }
      ```
  
      {% endcut %}
  
    - **Type**: object
  
      #|
      ||
  
      _errors_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      {% cut "**Type**: object[]" %}
  
      #|
      ||
  
      _code_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string
  
      The error code.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      ||
  
      _message_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string
  
      Description of the error.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% endcut %}
  
      A list of errors.
  
      _Min items:_{.json-schema-reset .json-schema-assertion} `1`
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      ```
  
      {% endcut %}
  
    {% endcut %}
  
    A standard wrapper for server errors.
  
    {% cut "**Example**" %}{.json-schema-example}
  
    ```json translate=no
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    ```
  
    {% endcut %}
  
  {% endcut %}
  
  </div>
  
  </div>
  
  <div class="openapi__response__code__500">
  
  ## 500 Internal Server Error
  
  Internal error of Yandex. Market. [More information about the error](https://yandex.com/dev/market/partner-api/doc/en/concepts/error-codes.md#500)
  
  <div class="openapi-entity">
  
  ### Body
  
  {% cut "application/json" %}
  
  ```json translate=no
  {
    "status": "OK",
    "errors": [
      {
        "code": "example",
        "message": "example"
      }
    ]
  }
  ```
  
  {% endcut %}
  
  **Type**: object
  
  {% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}
  
  - **Type**: object
  
    {% cut "**All of 2 types**" %}{.json-schema-combinators data-marker=and}
  
    - **Type**: object
  
      #|
      ||
  
      _status_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string
  
      The type of response.
      Possible values:
      * `OK` — There are no errors.
      * `ERROR` — an error occurred while processing the request.
  
  
      _Enum:_{.json-schema-reset .json-schema-value} `OK`, `ERROR`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      The standard wrapper for server responses.
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "status": "OK"
      }
      ```
  
      {% endcut %}
  
    - **Type**: object
  
      #|
      ||
  
      _errors_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      {% cut "**Type**: object[]" %}
  
      #|
      ||
  
      _code_{.json-schema-reset .json-schema-property .json-schema-required}
      {.table-cell}|
      **Type**: string
  
      The error code.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      ||
  
      _message_{.json-schema-reset .json-schema-property}
      {.table-cell}|
      **Type**: string
  
      Description of the error.
  
      _Example:_{.json-schema-reset .json-schema-example} `example`
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% endcut %}
  
      A list of errors.
  
      _Min items:_{.json-schema-reset .json-schema-assertion} `1`
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      ```
  
      {% endcut %}
      {.table-cell}
      ||
      |#{.json-schema-properties}
  
      {% cut "**Example**" %}{.json-schema-example}
  
      ```json translate=no
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      ```
  
      {% endcut %}
  
    {% endcut %}
  
    A standard wrapper for server errors.
  
    {% cut "**Example**" %}{.json-schema-example}
  
    ```json translate=no
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    ```
  
    {% endcut %}
  
  {% endcut %}
  
  </div>
  
  </div>
        

- Console

  ```openapi-sandbox translate=no
  pathParams:
    - description: "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.\n\nYou can find it using a query [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md) 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**:\n\n* block **Campaign ID**;\n* tab **Query log** → drop-down list in the block **Show logs**.\n\n⚠️ Do not confuse it with:\n- the store's identifier, which is displayed in the merchant's personal account.\n- advertising campaigns.\n"
      name: campaignId
      in: path
      required: true
      schema:
        type: integer
        format: int64
        minimum: 1
    - description: Shipment ID.
      name: shipmentId
      in: path
      required: true
      schema:
        type: integer
        format: int64
        minimum: 1
  searchParams:
    - description: >
        Whether to refund cancelled orders.
  
  
        Default value: `true`. If you do not need to refund
        cancelled orders, pass the value `false`.
      name: cancelledOrders
      in: query
      required: false
      schema:
        type: boolean
        default: true
  headers: []
  body: null
  schema: {}
  method: get
  security:
    - type: apiKey
      name: 'Api-Key'
      in: header
    - type: oauth2
      x-inline: true
      flows:
        implicit:
          authorizationUrl: https://oauth.yandex.ru/authorize
          scopes:
            market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
  path: v2/campaigns/{campaignId}/first-mile/shipments/{shipmentId}
  host: https://api.partner.market.yandex.ru
  
  ```
        

{% endlist %}


</div>
<!-- endsource: en/api/shipments/getShipment.md -->


[*Deprecated]: No longer supported, please use an alternative and newer version.