Changing the statuses of multiple orders

The method is available for models: FBS, Express and DBS.

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

Changes the statuses of several orders.

Possible status changes:

  • If the store has confirmed and prepared the order for shipment, then the order from the status "status": "PROCESSING"and the processing stage "substatus": "STARTED" it needs to be converted to the status "status": "PROCESSING" and the processing stage "substatus": "READY_TO_SHIP".
  • If the store has confirmed the order, but cannot fulfill it (for example, the product is listed in the database, but is not in stock or does not have the desired color), then the order status "status": "PROCESSING" and the processing stage "substatus": "STARTED" it needs to be converted to the status "status": "CANCELLED" with the reason for the cancellation of the order "substatus": "SHOP_FAILED".
  • If the store has prepared an order for shipment, but cannot fulfill it (for example, the last item was damaged or defective), then the order status is "status": "PROCESSING" and the processing stage "substatus": "READY_TO_SHIP" it needs to be converted to the status "status": "CANCELLED" with the reason for the cancellation of the order "substatus": "SHOP_FAILED".
⚙️ Limit: 100,000 orders per hour

Request

POST

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/orders/status-update

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

Body

application/json
{
  "orders": [
    {
      "id": 0,
      "status": "PLACING",
      "substatus": "RESERVATION_EXPIRED"
    }
  ]
}

Name

Description

orders
Type: object[]

id

Type: integer

The order ID.

status

Type: string

Order status:

  • PLACING — it is being processed, preparing for the reservation.

  • RESERVED — reserved, but under-booked.

  • UNPAID — issued, but not yet paid (if payment is selected at checkout).

  • PROCESSING — it is under processing.

  • DELIVERY — transferred to the delivery service.

  • PICKUP — delivered to the pick-up point.

  • DELIVERED — received by the buyer.

  • CANCELLED — cancelled.

  • PENDING — awaiting processing by the seller.

  • PARTIALLY_RETURNED — partially refunded.

  • RETURNED — returned in full.

  • UNKNOWN — unknown status.

Other values may also be returned. You don't need to process them.

Enum: PLACING, RESERVED, UNPAID, PROCESSING, DELIVERY, PICKUP, DELIVERED, CANCELLED, PENDING, PARTIALLY_RETURNED, RETURNED, UNKNOWN

substatus

Type: string

Order processing stage (status PROCESSING) or the reason for the cancellation of the order (status CANCELLED).

  • Order values in the status PROCESSING:

    • STARTED — The order has been confirmed, and it can be processed.

    • READY_TO_SHIP — the order is assembled and ready for shipment.

  • Order values in the status CANCELLED:

    • RESERVATION_EXPIRED — The customer did not complete the reserved order within 10 minutes.

    • USER_NOT_PAID — the buyer did not pay for the order (for the type of payment PREPAID) for 30 minutes.

    • USER_UNREACHABLE — couldn't contact the buyer. To cancel with this reason, the following conditions must be met:

      • at least 3 calls from 8 to 21 in the buyer's time zone;
      • the break between the first and third calls is at least 90 minutes;
      • the connection is no shorter than 5 seconds.

      If at least one of these conditions is not met (except when the number is unavailable), you will not be able to cancel the order. A response with the error code 400 will be returned.

    • USER_CHANGED_MIND — the customer cancelled the order for personal reasons.

    • USER_REFUSED_DELIVERY — the buyer was not satisfied with the terms of delivery.

    • USER_REFUSED_PRODUCT — the product did not fit the buyer.

    • SHOP_FAILED — the store cannot complete the order.

    • USER_REFUSED_QUALITY — the buyer was not satisfied with the quality of the product.

    • REPLACING_ORDER — the buyer decided to replace the product with another one on his own initiative.

    • PROCESSING_EXPIRED — the value is no longer used.

    • PICKUP_EXPIRED — The shelf life of the order at the pick-up point has expired.

    • TOO_MANY_DELIVERY_DATE_CHANGES — the order has been postponed too many times.

    • TOO_LONG_DELIVERY — The order is taking too long to be delivered.

    • INCORRECT_PERSONAL_DATA — For an order from abroad, the recipient's information is incorrect, and the order will not be checked at customs.

  • TECHNICAL_ERROR — a technical error on the Market's side. Contact support.

Other values may also be returned. You don't need to process them.

Enum: RESERVATION_EXPIRED, USER_NOT_PAID, USER_UNREACHABLE, USER_CHANGED_MIND, USER_REFUSED_DELIVERY, USER_REFUSED_PRODUCT, SHOP_FAILED, USER_REFUSED_QUALITY, REPLACING_ORDER, PROCESSING_EXPIRED, PENDING_EXPIRED, SHOP_PENDING_CANCELLED, PENDING_CANCELLED, USER_FRAUD, RESERVATION_FAILED, USER_PLACED_OTHER_ORDER, USER_BOUGHT_CHEAPER, MISSING_ITEM, BROKEN_ITEM, WRONG_ITEM, PICKUP_EXPIRED, DELIVERY_PROBLEMS, LATE_CONTACT, CUSTOM, DELIVERY_SERVICE_FAILED, WAREHOUSE_FAILED_TO_SHIP, DELIVERY_SERVICE_UNDELIVERED, PREORDER, AWAIT_CONFIRMATION, STARTED, PACKAGING, READY_TO_SHIP, SHIPPED, ASYNC_PROCESSING, WAITING_USER_INPUT, WAITING_BANK_DECISION, BANK_REJECT_CREDIT_OFFER, CUSTOMER_REJECT_CREDIT_OFFER, CREDIT_OFFER_FAILED, AWAIT_DELIVERY_DATES_CONFIRMATION, SERVICE_FAULT, DELIVERY_SERVICE_RECEIVED, USER_RECEIVED, WAITING_FOR_STOCKS, AS_PART_OF_MULTI_ORDER, READY_FOR_LAST_MILE, LAST_MILE_STARTED, ANTIFRAUD, DELIVERY_USER_NOT_RECEIVED, DELIVERY_SERVICE_DELIVERED, DELIVERED_USER_NOT_RECEIVED, USER_WANTED_ANOTHER_PAYMENT_METHOD, USER_RECEIVED_TECHNICAL_ERROR, USER_FORGOT_TO_USE_BONUS, DELIVERY_SERVICE_NOT_RECEIVED, DELIVERY_SERVICE_LOST, SHIPPED_TO_WRONG_DELIVERY_SERVICE, DELIVERED_USER_RECEIVED, WAITING_TINKOFF_DECISION, COURIER_SEARCH, COURIER_FOUND, COURIER_IN_TRANSIT_TO_SENDER, COURIER_ARRIVED_TO_SENDER, COURIER_RECEIVED, COURIER_NOT_FOUND, COURIER_NOT_DELIVER_ORDER, COURIER_RETURNS_ORDER, COURIER_RETURNED_ORDER, WAITING_USER_DELIVERY_INPUT, PICKUP_SERVICE_RECEIVED, PICKUP_USER_RECEIVED, CANCELLED_COURIER_NOT_FOUND, COURIER_NOT_COME_FOR_ORDER, DELIVERY_NOT_MANAGED_REGION, INCOMPLETE_CONTACT_INFORMATION, INCOMPLETE_MULTI_ORDER, INAPPROPRIATE_WEIGHT_SIZE, TECHNICAL_ERROR, SORTING_CENTER_LOST, COURIER_SEARCH_NOT_STARTED, LOST, AWAIT_PAYMENT, AWAIT_LAVKA_RESERVATION, USER_WANTS_TO_CHANGE_ADDRESS, FULL_NOT_RANSOM, PRESCRIPTION_MISMATCH, DROPOFF_LOST, DROPOFF_CLOSED, DELIVERY_TO_STORE_STARTED, USER_WANTS_TO_CHANGE_DELIVERY_DATE, WRONG_ITEM_DELIVERED, DAMAGED_BOX, AWAIT_DELIVERY_DATES, LAST_MILE_COURIER_SEARCH, PICKUP_POINT_CLOSED, LEGAL_INFO_CHANGED, USER_HAS_NO_TIME_TO_PICKUP_ORDER, DELIVERY_CUSTOMS_ARRIVED, DELIVERY_CUSTOMS_CLEARED, FIRST_MILE_DELIVERY_SERVICE_RECEIVED, AWAIT_AUTO_DELIVERY_DATES, AWAIT_USER_PERSONAL_DATA, NO_PERSONAL_DATA_EXPIRED, CUSTOMS_PROBLEMS, AWAIT_CASHIER, WAITING_POSTPAID_BUDGET_RESERVATION, AWAIT_SERVICEABLE_CONFIRMATION, POSTPAID_BUDGET_RESERVATION_FAILED, AWAIT_CUSTOM_PRICE_CONFIRMATION, READY_FOR_PICKUP, TOO_MANY_DELIVERY_DATE_CHANGES, TOO_LONG_DELIVERY, DEFERRED_PAYMENT, POSTPAID_FAILED, INCORRECT_PERSONAL_DATA, UNKNOWN

The list of orders.

Min items: 1

Max items: 30

Example
[
  {
    "id": 0,
    "status": "PLACING",
    "substatus": "RESERVATION_EXPIRED"
  }
]

Responses

200 OK

Information about updated order statuses is returned.

Body

application/json
{
  "status": "OK",
  "result": {
    "orders": [
      {
        "id": 0,
        "status": "PLACING",
        "substatus": "RESERVATION_EXPIRED",
        "updateStatus": "OK",
        "errorDetails": "example",
        "operation": {}
      }
    ]
  }
}

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

    orders
    Type: object[]

    errorDetails

    Type: string

    Error when changing the order status. It contains a description of the error and the order ID.

    Returned if the parameter updateStatus takes the value ERROR.

    Example: example

    id

    Type: integer

    The order ID.

    operation
    Type: object

    id

    Type: string

    ID of the operation.

    Min length: 1

    Max length: 1000

    Example: example

    type

    Type: string

    Type of operation:

    • ORDER_RECIPIENT_UPDATE — changing the recipient's data.

    • ORDER_DELIVERY_INTERVAL_UPDATE — changing the delivery date interval.

    • ORDER_STATUS_UPDATE — updating the order status to cancel it.

    • RETURN_CANCELLATION — cancellation of the refund.

    Enum: ORDER_RECIPIENT_UPDATE, ORDER_DELIVERY_INTERVAL_UPDATE, ORDER_STATUS_UPDATE, RETURN_CANCELLATION

    Information about the operation.

    Example
    {
  "id": "example",
  "type": "ORDER_RECIPIENT_UPDATE"
}

    status

    Type: string

    Order status:

    • PLACING — it is being processed, preparing for the reservation.

    • RESERVED — reserved, but under-booked.

    • UNPAID — issued, but not yet paid (if payment is selected at checkout).

    • PROCESSING — it is under processing.

    • DELIVERY — transferred to the delivery service.

    • PICKUP — delivered to the pick-up point.

    • DELIVERED — received by the buyer.

    • CANCELLED — cancelled.

    • PENDING — awaiting processing by the seller.

    • PARTIALLY_RETURNED — partially refunded.

    • RETURNED — returned in full.

    • UNKNOWN — unknown status.

    Other values may also be returned. You don't need to process them.

    Enum: PLACING, RESERVED, UNPAID, PROCESSING, DELIVERY, PICKUP, DELIVERED, CANCELLED, PENDING, PARTIALLY_RETURNED, RETURNED, UNKNOWN

    substatus

    Type: string

    Order processing stage (status PROCESSING) or the reason for the cancellation of the order (status CANCELLED).

    • Order values in the status PROCESSING:

      • STARTED — The order has been confirmed, and it can be processed.

      • READY_TO_SHIP — the order is assembled and ready for shipment.

    • Order values in the status CANCELLED:

      • RESERVATION_EXPIRED — The customer did not complete the reserved order within 10 minutes.

      • USER_NOT_PAID — the buyer did not pay for the order (for the type of payment PREPAID) for 30 minutes.

      • USER_UNREACHABLE — couldn't contact the buyer. To cancel with this reason, the following conditions must be met:

        • at least 3 calls from 8 to 21 in the buyer's time zone;
        • the break between the first and third calls is at least 90 minutes;
        • the connection is no shorter than 5 seconds.

        If at least one of these conditions is not met (except when the number is unavailable), you will not be able to cancel the order. A response with the error code 400 will be returned.

      • USER_CHANGED_MIND — the customer cancelled the order for personal reasons.

      • USER_REFUSED_DELIVERY — the buyer was not satisfied with the terms of delivery.

      • USER_REFUSED_PRODUCT — the product did not fit the buyer.

      • SHOP_FAILED — the store cannot complete the order.

      • USER_REFUSED_QUALITY — the buyer was not satisfied with the quality of the product.

      • REPLACING_ORDER — the buyer decided to replace the product with another one on his own initiative.

      • PROCESSING_EXPIRED — the value is no longer used.

      • PICKUP_EXPIRED — The shelf life of the order at the pick-up point has expired.

      • TOO_MANY_DELIVERY_DATE_CHANGES — the order has been postponed too many times.

      • TOO_LONG_DELIVERY — The order is taking too long to be delivered.

      • INCORRECT_PERSONAL_DATA — For an order from abroad, the recipient's information is incorrect, and the order will not be checked at customs.

    • TECHNICAL_ERROR — a technical error on the Market's side. Contact support.

    Other values may also be returned. You don't need to process them.

    Enum: RESERVATION_EXPIRED, USER_NOT_PAID, USER_UNREACHABLE, USER_CHANGED_MIND, USER_REFUSED_DELIVERY, USER_REFUSED_PRODUCT, SHOP_FAILED, USER_REFUSED_QUALITY, REPLACING_ORDER, PROCESSING_EXPIRED, PENDING_EXPIRED, SHOP_PENDING_CANCELLED, PENDING_CANCELLED, USER_FRAUD, RESERVATION_FAILED, USER_PLACED_OTHER_ORDER, USER_BOUGHT_CHEAPER, MISSING_ITEM, BROKEN_ITEM, WRONG_ITEM, PICKUP_EXPIRED, DELIVERY_PROBLEMS, LATE_CONTACT, CUSTOM, DELIVERY_SERVICE_FAILED, WAREHOUSE_FAILED_TO_SHIP, DELIVERY_SERVICE_UNDELIVERED, PREORDER, AWAIT_CONFIRMATION, STARTED, PACKAGING, READY_TO_SHIP, SHIPPED, ASYNC_PROCESSING, WAITING_USER_INPUT, WAITING_BANK_DECISION, BANK_REJECT_CREDIT_OFFER, CUSTOMER_REJECT_CREDIT_OFFER, CREDIT_OFFER_FAILED, AWAIT_DELIVERY_DATES_CONFIRMATION, SERVICE_FAULT, DELIVERY_SERVICE_RECEIVED, USER_RECEIVED, WAITING_FOR_STOCKS, AS_PART_OF_MULTI_ORDER, READY_FOR_LAST_MILE, LAST_MILE_STARTED, ANTIFRAUD, DELIVERY_USER_NOT_RECEIVED, DELIVERY_SERVICE_DELIVERED, DELIVERED_USER_NOT_RECEIVED, USER_WANTED_ANOTHER_PAYMENT_METHOD, USER_RECEIVED_TECHNICAL_ERROR, USER_FORGOT_TO_USE_BONUS, DELIVERY_SERVICE_NOT_RECEIVED, DELIVERY_SERVICE_LOST, SHIPPED_TO_WRONG_DELIVERY_SERVICE, DELIVERED_USER_RECEIVED, WAITING_TINKOFF_DECISION, COURIER_SEARCH, COURIER_FOUND, COURIER_IN_TRANSIT_TO_SENDER, COURIER_ARRIVED_TO_SENDER, COURIER_RECEIVED, COURIER_NOT_FOUND, COURIER_NOT_DELIVER_ORDER, COURIER_RETURNS_ORDER, COURIER_RETURNED_ORDER, WAITING_USER_DELIVERY_INPUT, PICKUP_SERVICE_RECEIVED, PICKUP_USER_RECEIVED, CANCELLED_COURIER_NOT_FOUND, COURIER_NOT_COME_FOR_ORDER, DELIVERY_NOT_MANAGED_REGION, INCOMPLETE_CONTACT_INFORMATION, INCOMPLETE_MULTI_ORDER, INAPPROPRIATE_WEIGHT_SIZE, TECHNICAL_ERROR, SORTING_CENTER_LOST, COURIER_SEARCH_NOT_STARTED, LOST, AWAIT_PAYMENT, AWAIT_LAVKA_RESERVATION, USER_WANTS_TO_CHANGE_ADDRESS, FULL_NOT_RANSOM, PRESCRIPTION_MISMATCH, DROPOFF_LOST, DROPOFF_CLOSED, DELIVERY_TO_STORE_STARTED, USER_WANTS_TO_CHANGE_DELIVERY_DATE, WRONG_ITEM_DELIVERED, DAMAGED_BOX, AWAIT_DELIVERY_DATES, LAST_MILE_COURIER_SEARCH, PICKUP_POINT_CLOSED, LEGAL_INFO_CHANGED, USER_HAS_NO_TIME_TO_PICKUP_ORDER, DELIVERY_CUSTOMS_ARRIVED, DELIVERY_CUSTOMS_CLEARED, FIRST_MILE_DELIVERY_SERVICE_RECEIVED, AWAIT_AUTO_DELIVERY_DATES, AWAIT_USER_PERSONAL_DATA, NO_PERSONAL_DATA_EXPIRED, CUSTOMS_PROBLEMS, AWAIT_CASHIER, WAITING_POSTPAID_BUDGET_RESERVATION, AWAIT_SERVICEABLE_CONFIRMATION, POSTPAID_BUDGET_RESERVATION_FAILED, AWAIT_CUSTOM_PRICE_CONFIRMATION, READY_FOR_PICKUP, TOO_MANY_DELIVERY_DATE_CHANGES, TOO_LONG_DELIVERY, DEFERRED_PAYMENT, POSTPAID_FAILED, INCORRECT_PERSONAL_DATA, UNKNOWN

    updateStatus

    Type: string

    Has the order status changed:

    • OK — the status has been changed.

    • ERROR — the status has not been changed. In this case, an error message will appear in the parameter errorDetails.

    Enum: OK, ERROR

    A list with updated orders.

    Example
    [
  {
    "id": 0,
    "status": "PLACING",
    "substatus": "RESERVATION_EXPIRED",
    "updateStatus": "OK",
    "errorDetails": "example",
    "operation": {
      "id": "example",
      "type": "ORDER_RECIPIENT_UPDATE"
    }
  }
]

    The list of orders whose status has been updated.

    Example
    {
  "orders": [
    {
      "id": 0,
      "status": "PLACING",
      "substatus": "RESERVATION_EXPIRED",
      "updateStatus": "OK",
      "errorDetails": "example",
      "operation": {
        "id": "example",
        "type": "ORDER_RECIPIENT_UPDATE"
      }
    }
  ]
}
    Example
    {
  "result": {
    "orders": [
      {
        "id": 0,
        "status": "PLACING",
        "substatus": "RESERVATION_EXPIRED",
        "updateStatus": "OK",
        "errorDetails": "example",
        "operation": {
          "id": "example",
          "type": "ORDER_RECIPIENT_UPDATE"
        }
      }
    ]
  }
}

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

No longer supported, please use an alternative and newer version.

Previous
Changing the status of an order
Next
Transmission of marking codes