Замены товаров в заказе

Создание замены товаров в заказе. PUSH-метод. Позволяет партнеру сообщить Яндекс Еде о недоступных товарах в заказе и предложить замены

Request

POST

/partner-integration/v1/order/replacements

Headers

Name

Description

Authorization

Type: string

Токен, сформированный на стороне Яндекс Еды.

Example: ``

Body

application/json
{
  "order_id": "03d3b69b-331c-4f84-b2c4-888b30320e63",
  "items": {
    "some-uniq-identifier-001": {
      "quantity": "2",
      "replaced_quantity": "1",
      "replacements": [
        "some-uniq-identifier-002",
        "some-uniq-identifier-003"
      ]
    }
  }
}

Name

Description

items

Type: object

[additional]

Type: ReplacementsItem

Товар в заказе, который нужно заменить

Example
{
  "quantity": "3.4",
  "replaced_quantity": "2",
  "replacements": [
    "some-uniq-identifier"
  ]
}

Словарь замен товаров, где ключ - origin_id товара, который нужно заменить

Example
{
  "some-uniq-identifier-001": {
    "quantity": "2",
    "replaced_quantity": "1",
    "replacements": [
      "some-uniq-identifier-002",
      "some-uniq-identifier-003"
    ]
  }
}

order_id

Type: string

ID заказа в системе Партнёра

Example: 03d3b69b-331c-4f84-b2c4-888b30320e63

Replacement

Артикул/SKU предлагаемого аналога

Type: string

Example: some-uniq-identifier

ReplacementsItem

Товар в заказе, который нужно заменить

Name

Description

quantity

Type: string

Общее количество единиц, которое было заказано. Для весовых товаров количество передается в кг.

Pattern: ^[0-9]+(\.[0-9]{1,3})?$

Example: 3.4

replaced_quantity

Type: string

Количество единиц, которое нужно заменить (может быть меньше заказанного — частичная замена). Для весовых товаров количество передается в кг.

Pattern: ^[0-9]+(\.[0-9]{1,3})?$

Example: 2

replacements

Type: Replacement[]

Список предлагаемых аналогов

Example
[
  "some-uniq-identifier"
]
Example
{
  "quantity": "3.4",
  "replaced_quantity": "2",
  "replacements": [
    "some-uniq-identifier"
  ]
}

Responses

204 No Content

Замены товаров в заказе успешно приняты

400 Bad Request

Неверно сформированный запрос

Body

application/json
{
  "message": "example",
  "code": 0,
  "details": {}
}

Name

Description

code

Type: integer

Код ошибки.

message

Type: string

Сообщение об ошибке.

Example: example

details

Type: object
Example
{}

401 Unauthorized

Не пройдена авторизация - истек токен, либо не был передан в запросе

Body

application/json
{
  "message": "example",
  "code": 0,
  "details": {}
}

Name

Description

code

Type: integer

Код ошибки.

message

Type: string

Сообщение об ошибке.

Example: example

details

Type: object
Example
{}

403 Forbidden

Нет доступа для создания замен товаров в заказе

Body

application/json
{
  "message": "example",
  "code": 0,
  "details": {}
}

Name

Description

code

Type: integer

Код ошибки.

message

Type: string

Сообщение об ошибке.

Example: example

details

Type: object
Example
{}

429 Too Many Requests

Слишком много запросов

Body

application/json
{
  "message": "example",
  "code": 0,
  "details": {}
}

Name

Description

code

Type: integer

Код ошибки.

message

Type: string

Сообщение об ошибке.

Example: example

details

Type: object
Example
{}

500 Internal Server Error

Внутренняя ошибка сервиса, необходимо повторить запрос

Body

application/json
{
  "message": "example",
  "code": 0,
  "details": {}
}

Name

Description

code

Type: integer

Код ошибки.

message

Type: string

Сообщение об ошибке.

Example: example

details

Type: object
Example
{}