Receiving information about orders for delivery, removal and disposal

Info

Console

The method is available for the FBY model.

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

supplies-management:read-only — View FBY requests
all-methods — Full account management
all-methods:read-only — View all data

Returns requests for delivery, export, and disposal, as well as information on them, using the specified filters.

⚙️ Limit: 1,000 requests per hour

Request

POST

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/supply-requests

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

Query parameters

Name

Description

limit

Type: integer

The number of values per page.

Min value: 1

page_token

Type: string

ID of the results page.

If the parameter is omitted, the first page is returned.

We recommend transmitting the value of the output parameter nextPageToken, received during the last request.

If set page_token and the request has parameters page and pageSize they are ignored.

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json

{
  "requestIds": [
    1
  ],
  "requestDateFrom": "2025-01-01T00:00:00Z",
  "requestDateTo": "2025-01-01T00:00:00Z",
  "requestTypes": [
    "SUPPLY"
  ],
  "requestSubtypes": [
    "DEFAULT"
  ],
  "requestStatuses": [
    "CREATED"
  ],
  "sorting": {
    "direction": "ASC",
    "attribute": "ID"
  }
}

Name

Description

requestDateFrom

Type: string<date-time> | null

The start date of the request filtering period.

Example: 2025-01-01T00:00:00Z

requestDateTo

Type: string<date-time> | null

The end date of the request filtering period.

Example: 2025-01-01T00:00:00Z

requestIds

Type: integer[] | null

Request IDs.

Min items: 1

Max items: 100

Unique items: true

Example

[
  1
]

requestStatuses

Type: string[] | null

Request statuses for filtering.

Min items: 1

Unique items: true

Example

[
  "CREATED"
]

requestSubtypes

Type: string[] | null

Subtypes of requests for filtering.

Min items: 1

Unique items: true

Example

[
  "DEFAULT"
]

requestTypes

Type: string[] | null

Types of requests to filter.

Min items: 1

Unique items: true

Example

[
  "SUPPLY"
]

sorting

Type: object

attribute

Type: string

Which parameter to sort applications by:

ID — the application ID.
REQUESTED_DATE — date of delivery to the storage warehouse.

If the goods passed through a transit warehouse, it sorts them by delivery dates to both warehouses.
UPDATED_AT — the time of the application update.
STATUS — the status of the application.

Enum: ID, REQUESTED_DATE, UPDATED_AT, STATUS

direction

Type: string

Sorting direction:

ASC — sort in ascending order.
DESC — sort in descending order.

Enum: ASC, DESC

Sorting parameters.

Example

{
  "direction": "ASC",
  "attribute": "ID"
}

Responses

200 OK

A list of applications and information on them.

Body

application/json

{
  "status": "OK",
  "result": {
    "requests": [
      {
        "id": {},
        "type": "SUPPLY",
        "subtype": "DEFAULT",
        "status": "CREATED",
        "updatedAt": "2025-01-01T00:00:00Z",
        "counters": {},
        "parentLink": {},
        "childrenLinks": [
          null
        ],
        "targetLocation": {},
        "transitLocation": {}
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

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

requests

Type: object[]

counters

Type: object

acceptableCount	Type: integer The number of items that can be brought additionally. Min value: `0`
actualBoxCount	Type: integer The number of boxes that are accepted in the warehouse. Min value: `0`
actualPalletsCount	Type: integer The number of pallets that are accepted in the warehouse. Min value: `0`
defectCount	Type: integer The number of defective products. Min value: `0`
factCount	Type: integer The number of items that are accepted in the warehouse. Min value: `0`
planCount	Type: integer The number of items in the delivery request. Min value: `0`
shortageCount	Type: integer The number of defective products. Min value: `0`
surplusCount	Type: integer The number of extra items. Min value: `0`
unacceptableCount	Type: integer The number of items that cannot be delivered additionally. Min value: `0`
undefinedCount	Type: integer The number of rejected products. Min value: `0`

The number of goods, boxes and pallets in the application.

Example

{
  "planCount": 0,
  "factCount": 0,
  "undefinedCount": 0,
  "surplusCount": 0,
  "shortageCount": 0,
  "defectCount": 0,
  "acceptableCount": 0,
  "unacceptableCount": 0,
  "actualPalletsCount": 0,
  "actualBoxCount": 0
}

Type: object

Type: integer

The application ID.

Used only in the API

It will not be possible to find applications in the seller's account on the Market. To do this, use marketplaceRequestId or warehouseRequestId.

Min value: 1

marketplaceRequestId

Type: string

The application number on the marketplace.

It is also indicated in the seller's account on the Market.

Example: example

warehouseRequestId

Type: string

The order number in the warehouse.

It is also indicated in the seller's account on the Market.

Example: example

The application ID and numbers.

Example

{
  "id": 1,
  "marketplaceRequestId": "example",
  "warehouseRequestId": "example"
}

status

Type: string

Delivery request status:

CREATED — A draft application has been created.
FINISHED — The application is completed, the goods are:
- accepted at the warehouse;
- transferred to another warehouse during the transfer;
- transferred to the seller during export;
- disposed of.
CANCELLED — the application has been cancelled.
INVALID — processing error.
VALIDATED — the application is being processed.
PUBLISHED — An application has been created.
ARRIVED_TO_SERVICE — The delivery has arrived at the storage warehouse.
ARRIVED_TO_XDOC_SERVICE — The delivery has arrived at the transit warehouse.
SHIPPED_TO_SERVICE — The delivery was sent from the transit warehouse to the storage warehouse.
CANCELLATION_REQUESTED — cancellation of the request has been requested.
CANCELLATION_REJECTED — The application will not be cancelled.
REGISTERED_IN_ELECTRONIC_QUEUE — the delivery is registered in the electronic queue.
READY_FOR_UTILIZATION — the goods are ready for disposal.
TRANSIT_MOVING — moving goods to the export warehouse.
WAREHOUSE_HANDLING — secondary acceptance of goods or their assembly for export or disposal.
ACCEPTED_BY_WAREHOUSE_SYSTEM — information about the application has been sent to the warehouse.
READY_TO_WITHDRAW — the goods are ready for delivery.
NEED_PREPARATION — information is expected from the seller.

Enum: CREATED, FINISHED, CANCELLED, INVALID, VALIDATED, PUBLISHED, ARRIVED_TO_SERVICE, ARRIVED_TO_XDOC_SERVICE, SHIPPED_TO_SERVICE, CANCELLATION_REQUESTED, CANCELLATION_REJECTED, REGISTERED_IN_ELECTRONIC_QUEUE, READY_FOR_UTILIZATION, TRANSIT_MOVING, WAREHOUSE_HANDLING, ACCEPTED_BY_WAREHOUSE_SYSTEM, READY_TO_WITHDRAW, NEED_PREPARATION

subtype

Type: string

Application subtype:

DEFAULT — delivery of goods to or from a storage warehouse.
XDOC — delivery of goods through a transit warehouse or export from it.
INVENTORYING_SUPPLY — inventory in the warehouse at the request of the store.
INVENTORYING_SUPPLY_WAREHOUSE_BASED_PER_SUPPLIER — inventory in the warehouse at the request of the warehouse.
MOVEMENT_SUPPLY — incoming movement between warehouses.

When moving between warehouses, 2 orders are created — MOVEMENT_SUPPLY and MOVEMENT_WITHDRAW.
ADDITIONAL_SUPPLY — additional delivery of rejected goods.
VIRTUAL_DISTRIBUTION_CENTER — parent request for delivery of goods to a storage warehouse or multi-delivery.
VIRTUAL_DISTRIBUTION_CENTER_CHILD — a subsidiary request for the delivery of goods to a storage warehouse or multi-delivery.

It doesn't come back for her transitLocation.
FORCE_PLAN — automatic disposal at the request of the warehouse.
FORCE_PLAN_ANOMALY_PER_SUPPLY — disposal of rejected goods.
PLAN_BY_SUPPLIER — disposal at the request of the store.
ANOMALY_WITHDRAW — export of rejected goods.
FIX_LOST_INVENTORYING — items that were not found after the second inventory.
OPER_LOST_INVENTORYING — items that were not found after the first inventory.
MOVEMENT_WITHDRAW — outbound movement between warehouses.

When moving between warehouses, 2 orders are created — MOVEMENT_SUPPLY and MOVEMENT_WITHDRAW.
MISGRADING_SUPPLY — re-sorting for the better.
MISGRADING_WITHDRAW — re-sorting in a smaller direction.
MAN_UTIL — manual disposal at the request of the warehouse.
WITHDRAW_AUTO_UTILIZATION — automatic disposal of goods in the export order when their storage period has expired.

Enum: DEFAULT, XDOC, INVENTORYING_SUPPLY, INVENTORYING_SUPPLY_WAREHOUSE_BASED_PER_SUPPLIER, MOVEMENT_SUPPLY, ADDITIONAL_SUPPLY, VIRTUAL_DISTRIBUTION_CENTER, VIRTUAL_DISTRIBUTION_CENTER_CHILD, FORCE_PLAN, FORCE_PLAN_ANOMALY_PER_SUPPLY, PLAN_BY_SUPPLIER, ANOMALY_WITHDRAW, FIX_LOST_INVENTORYING, OPER_LOST_INVENTORYING, MOVEMENT_WITHDRAW, MISGRADING_SUPPLY, MISGRADING_WITHDRAW, MAN_UTIL, WITHDRAW_AUTO_UTILIZATION

targetLocation

Type: object

address

Type: object

fullAddress

Type: string

The full address of the warehouse or PVZ.

Example: example

gps

Type: object

latitude

Type: number

Width.

longitude

Type: number

Longitude.

GPS coordinates of latitude and longitude.

Example

{
  "latitude": 0.5,
  "longitude": 0.5
}

The address of the warehouse or PVZ.

Example

{
  "fullAddress": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

name

Type: string

The name of the warehouse or PVZ.

Example: example

serviceId

Type: integer

ID of the warehouse or logistics partner of the PVZ.

type

Type: string

Type of warehouse or PVZ:

FULFILLMENT — storage warehouse.
XDOC — transit warehouse.
PICKUP_POINT — PVZ.

Enum: FULFILLMENT, XDOC, PICKUP_POINT

requestedDate

Type: string<date-time>

Date and time of delivery to the warehouse or to the PVZ.

Example: 2025-01-01T00:00:00Z

Information about the warehouse or PVZ in the application.

Example

{
  "requestedDate": "2025-01-01T00:00:00Z",
  "serviceId": 0,
  "name": "example",
  "address": {
    "fullAddress": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  },
  "type": "FULFILLMENT"
}

type

Type: string

Application type:

SUPPLY — delivery of goods.
WITHDRAW — export of goods.
UTILIZATION — disposal of goods.

Enum: SUPPLY, WITHDRAW, UTILIZATION

updatedAt

Type: string<date-time>

The date and time of the last application update.

Example: 2025-01-01T00:00:00Z

childrenLinks

Type: object[]

Type: object

Type: integer

The application ID.

Used only in the API

It will not be possible to find applications in the seller's account on the Market. To do this, use marketplaceRequestId or warehouseRequestId.

Min value: 1

marketplaceRequestId

Type: string

The application number on the marketplace.

It is also indicated in the seller's account on the Market.

Example: example

warehouseRequestId

Type: string

The order number in the warehouse.

It is also indicated in the seller's account on the Market.

Example: example

The application ID and numbers.

Example

{
  "id": 1,
  "marketplaceRequestId": "example",
  "warehouseRequestId": "example"
}

type

Type: string

The type of connection between the two applications:

VIRTUAL_DISTRIBUTION — multi-delivery.
WITHDRAW — export of rejected goods.

Subtypes of the application: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD and ANOMALY_WITHDRAW.
UTILIZATION — disposal of rejected goods.

Subtypes of the application: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD and FORCE_PLAN_ANOMALY_PER_SUPPLY.
ADDITIONAL_SUPPLY — additional delivery.

Subtypes of the application: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD and ADDITIONAL_SUPPLY.

Enum: VIRTUAL_DISTRIBUTION, WITHDRAW, UTILIZATION, ADDITIONAL_SUPPLY

Links to child applications.

Min items: 1

Example

[
  {
    "id": {
      "id": 1,
      "marketplaceRequestId": "example",
      "warehouseRequestId": "example"
    },
    "type": "VIRTUAL_DISTRIBUTION"
  }
]

parentLink

Type: object

Type: integer

The application ID.

Used only in the API

It will not be possible to find applications in the seller's account on the Market. To do this, use marketplaceRequestId or warehouseRequestId.

Min value: 1

marketplaceRequestId

Type: string

The application number on the marketplace.

It is also indicated in the seller's account on the Market.

Example: example

warehouseRequestId

Type: string

The order number in the warehouse.

It is also indicated in the seller's account on the Market.

Example: example

The application ID and numbers.

Example

{
  "id": 1,
  "marketplaceRequestId": "example",
  "warehouseRequestId": "example"
}

type

Type: string

The type of connection between the two applications:

VIRTUAL_DISTRIBUTION — multi-delivery.
WITHDRAW — export of rejected goods.

Subtypes of the application: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD and ANOMALY_WITHDRAW.
UTILIZATION — disposal of rejected goods.

Subtypes of the application: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD and FORCE_PLAN_ANOMALY_PER_SUPPLY.
ADDITIONAL_SUPPLY — additional delivery.

Subtypes of the application: DEFAULT, XDOC, VIRTUAL_DISTRIBUTION_CENTER_CHILD and ADDITIONAL_SUPPLY.

Enum: VIRTUAL_DISTRIBUTION, WITHDRAW, UTILIZATION, ADDITIONAL_SUPPLY

Information about related applications.

Example

{
  "id": {
    "id": 1,
    "marketplaceRequestId": "example",
    "warehouseRequestId": "example"
  },
  "type": "VIRTUAL_DISTRIBUTION"
}

transitLocation

Type: object

address

Type: object

fullAddress

Type: string

The full address of the warehouse or PVZ.

Example: example

gps

Type: object

latitude

Type: number

Width.

longitude

Type: number

Longitude.

GPS coordinates of latitude and longitude.

Example

{
  "latitude": 0.5,
  "longitude": 0.5
}

The address of the warehouse or PVZ.

Example

{
  "fullAddress": "example",
  "gps": {
    "latitude": 0.5,
    "longitude": 0.5
  }
}

name

Type: string

The name of the warehouse or PVZ.

Example: example

serviceId

Type: integer

ID of the warehouse or logistics partner of the PVZ.

type

Type: string

Type of warehouse or PVZ:

FULFILLMENT — storage warehouse.
XDOC — transit warehouse.
PICKUP_POINT — PVZ.

Enum: FULFILLMENT, XDOC, PICKUP_POINT

requestedDate

Type: string<date-time>

Date and time of delivery to the warehouse or to the PVZ.

Example: 2025-01-01T00:00:00Z

Information about the warehouse or PVZ in the application.

Example

{
  "requestedDate": "2025-01-01T00:00:00Z",
  "serviceId": 0,
  "name": "example",
  "address": {
    "fullAddress": "example",
    "gps": {
      "latitude": 0.5,
      "longitude": 0.5
    }
  },
  "type": "FULFILLMENT"
}

The list of applications.

Min items: 0

Max items: 100

Example

[
  {
    "id": {
      "id": 1,
      "marketplaceRequestId": "example",
      "warehouseRequestId": "example"
    },
    "type": "SUPPLY",
    "subtype": "DEFAULT",
    "status": "CREATED",
    "updatedAt": "2025-01-01T00:00:00Z",
    "counters": {
      "planCount": 0,
      "factCount": 0,
      "undefinedCount": 0,
      "surplusCount": 0,
      "shortageCount": 0,
      "defectCount": 0,
      "acceptableCount": 0,
      "unacceptableCount": 0,
      "actualPalletsCount": 0,
      "actualBoxCount": 0
    },
    "parentLink": {
      "id": {
        "id": 1,
        "marketplaceRequestId": "example",
        "warehouseRequestId": "example"
      },
      "type": "VIRTUAL_DISTRIBUTION"
    },
    "childrenLinks": [
      {
        "id": {
          "id": 1,
          "marketplaceRequestId": "example",
          "warehouseRequestId": "example"
        },
        "type": "VIRTUAL_DISTRIBUTION"
      }
    ],
    "targetLocation": {
      "requestedDate": "2025-01-01T00:00:00Z",
      "serviceId": 0,
      "name": "example",
      "address": {
        "fullAddress": "example",
        "gps": {
          "latitude": 0.5,
          "longitude": 0.5
        }
      },
      "type": "FULFILLMENT"
    },
    "transitLocation": {
      "requestedDate": "2025-01-01T00:00:00Z",
      "serviceId": 0,
      "name": "example",
      "address": {
        "fullAddress": "example",
        "gps": {
          "latitude": 0.5,
          "longitude": 0.5
        }
      },
      "type": "FULFILLMENT"
    }
  }
]

paging

Type: object

nextPageToken

Type: string

ID of the next results page.

Example: example

The ID of the next page.

Example

{
  "nextPageToken": "example"
}

A list of applications and information on them.

Example

{
  "requests": [
    {
      "id": {
        "id": 1,
        "marketplaceRequestId": "example",
        "warehouseRequestId": "example"
      },
      "type": "SUPPLY",
      "subtype": "DEFAULT",
      "status": "CREATED",
      "updatedAt": "2025-01-01T00:00:00Z",
      "counters": {
        "planCount": 0,
        "factCount": 0,
        "undefinedCount": 0,
        "surplusCount": 0,
        "shortageCount": 0,
        "defectCount": 0,
        "acceptableCount": 0,
        "unacceptableCount": 0,
        "actualPalletsCount": 0,
        "actualBoxCount": 0
      },
      "parentLink": {
        "id": {
          "id": 1,
          "marketplaceRequestId": "example",
          "warehouseRequestId": "example"
        },
        "type": "VIRTUAL_DISTRIBUTION"
      },
      "childrenLinks": [
        {
          "id": {},
          "type": "VIRTUAL_DISTRIBUTION"
        }
      ],
      "targetLocation": {
        "requestedDate": "2025-01-01T00:00:00Z",
        "serviceId": 0,
        "name": "example",
        "address": {
          "fullAddress": "example",
          "gps": {}
        },
        "type": "FULFILLMENT"
      },
      "transitLocation": {
        "requestedDate": "2025-01-01T00:00:00Z",
        "serviceId": 0,
        "name": "example",
        "address": {
          "fullAddress": "example",
          "gps": {}
        },
        "type": "FULFILLMENT"
      }
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}

Example

{
  "result": {
    "requests": [
      {
        "id": {
          "id": 1,
          "marketplaceRequestId": "example",
          "warehouseRequestId": "example"
        },
        "type": "SUPPLY",
        "subtype": "DEFAULT",
        "status": "CREATED",
        "updatedAt": "2025-01-01T00:00:00Z",
        "counters": {
          "planCount": 0,
          "factCount": 0,
          "undefinedCount": 0,
          "surplusCount": 0,
          "shortageCount": 0,
          "defectCount": 0,
          "acceptableCount": 0,
          "unacceptableCount": 0,
          "actualPalletsCount": 0,
          "actualBoxCount": 0
        },
        "parentLink": {
          "id": {},
          "type": "VIRTUAL_DISTRIBUTION"
        },
        "childrenLinks": [
          {}
        ],
        "targetLocation": {
          "requestedDate": "2025-01-01T00:00:00Z",
          "serviceId": 0,
          "name": "example",
          "address": {},
          "type": "FULFILLMENT"
        },
        "transitLocation": {
          "requestedDate": "2025-01-01T00:00:00Z",
          "serviceId": 0,
          "name": "example",
          "address": {},
          "type": "FULFILLMENT"
        }
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

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"
    }
  ]
}

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?

Labels for trust acceptance (FBS)

Products in the application