Изменение заказа

Метод доступен для модели LaaS.

Пока недоступен для продавцов Market Yandex Go.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Изменяет в заказе:

  • данные получателя;
  • интервал дат курьерской доставки.

Передавайте только ту информацию, которую хотите изменить. При необходимости вы можете отредактировать и данные получателя, и интервал доставки одновременно.

Заказ можно изменить в любом статусе до вручения покупателю или отмены (DELIVERED или CANCELLED).

Данные заказа обновляются не мгновенно

Изменения применяются в течение нескольких минут и только в случае успешного завершения операции. Как проверить статус операции

⚙️ Лимит: 10 000 запросов в час

Request

POST

https://api.partner.market.yandex.ru/v1/campaigns/{campaignId}/orders/update

Path parameters

Name

Description

campaignId

Type: integer

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Min value: 1

Body

application/json
{
  "order": {
    "id": 0,
    "deliveryInterval": {
      "deliveryDateInterval": {
        "fromDate": "2025-01-01",
        "toDate": "2025-01-01"
      },
      "deliveryTimeInterval": {
        "fromTime": "example",
        "toTime": "example"
      }
    },
    "customer": {
      "firstName": "example",
      "lastName": "example",
      "middleName": "example",
      "phone": "example"
    }
  }
}

Name

Description

order

Type: UpdateOrderDTO

Информация, которую нужно изменить.

Example
{
  "id": 0,
  "deliveryInterval": {
    "deliveryDateInterval": {
      "fromDate": "2025-01-01",
      "toDate": "2025-01-01"
    },
    "deliveryTimeInterval": {
      "fromTime": "example",
      "toTime": "example"
    }
  },
  "customer": {
    "firstName": "example",
    "lastName": "example",
    "middleName": "example",
    "phone": "example"
  }
}

DeliveryDateIntervalDTO

Интервал дат доставки.

Name

Description

fromDate

Type: string<date>

Начало интервала.

Формат даты: ГГГГ-ММ-ДД.

Example: 2025-01-01

toDate

Type: string<date>

Конец интервала.

Формат даты: ГГГГ-ММ-ДД.

Example: 2025-01-01
Example
{
  "fromDate": "2025-01-01",
  "toDate": "2025-01-01"
}

TimeIntervalDTO

Интервал времени доставки.

Name

Description

fromTime

Type: string

Начало интервала.

Формат: ЧЧ:ММ.

Pattern: ^([0-1][0-9]&#124;2[0-3]):[0-5][0-9]$

Example: example

toTime

Type: string

Конец интервала.

Формат: ЧЧ:ММ.

Pattern: ^([0-1][0-9]&#124;2[0-3]):[0-5][0-9]$

Example: example
Example
{
  "fromTime": "example",
  "toTime": "example"
}

DeliveryIntervalsUpdateOptionDTO

Интервалы дат и времени.

Name

Description

deliveryDateInterval

Type: DeliveryDateIntervalDTO

Интервал дат доставки.

Example
{
  "fromDate": "2025-01-01",
  "toDate": "2025-01-01"
}

deliveryTimeInterval

Type: TimeIntervalDTO

Интервал времени доставки.

Example
{
  "fromTime": "example",
  "toTime": "example"
}
Example
{
  "deliveryDateInterval": {
    "fromDate": "2025-01-01",
    "toDate": "2025-01-01"
  },
  "deliveryTimeInterval": {
    "fromTime": "example",
    "toTime": "example"
  }
}

CustomerDTO

Данные получателя заказа или отправителя возврата.

Name

Description

firstName

Type: string

Имя.

Min length: 1

Max length: 512

Example: example

lastName

Type: string

Фамилия.

Min length: 1

Max length: 512

Example: example

phone

Type: string

Номер телефона.

Формат: +<код_страны><код_региона><номер_телефона>.

Min length: 5

Max length: 16

Pattern: ^\+[0-9]+$

Example: example

middleName

Type: string

Отчество.

Min length: 1

Max length: 512

Example: example
Example
{
  "firstName": "example",
  "lastName": "example",
  "middleName": "example",
  "phone": "example"
}

UpdateOrderDTO

Информация, которую нужно изменить.

Name

Description

id

Type: integer

Идентификатор заказа, в котором нужны изменения.

customer

Type: CustomerDTO

Данные получателя заказа.

Данные получателя заказа или отправителя возврата.

Example
{
  "firstName": "example",
  "lastName": "example",
  "middleName": "example",
  "phone": "example"
}

deliveryInterval

Type: DeliveryIntervalsUpdateOptionDTO

Интервалы дат и времени, на которые можно изменить.

Только для курьерской доставки.

Интервалы дат и времени.

Example
{
  "deliveryDateInterval": {
    "fromDate": "2025-01-01",
    "toDate": "2025-01-01"
  },
  "deliveryTimeInterval": {
    "fromTime": "example",
    "toTime": "example"
  }
}
Example
{
  "id": 0,
  "deliveryInterval": {
    "deliveryDateInterval": {
      "fromDate": "2025-01-01",
      "toDate": "2025-01-01"
    },
    "deliveryTimeInterval": {
      "fromTime": "example",
      "toTime": "example"
    }
  },
  "customer": {
    "firstName": "example",
    "lastName": "example",
    "middleName": "example",
    "phone": "example"
  }
}

Responses

200 OK

Информация об операции по изменению заказа.

Ответ 200 не значит, что данные изменены

При успешном выполнении запроса это произойдет через некоторое время. Как проверить статус операции

Body

application/json
{
  "status": "OK",
  "result": {
    "operations": [
      {
        "id": "example",
        "type": "ORDER_RECIPIENT_UPDATE"
      }
    ]
  }
}

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    result

    Type: UpdateOrderResultDTO

    Информация об операции по изменению заказа.

    Example
    {
  "operations": [
    {
      "id": "example",
      "type": "ORDER_RECIPIENT_UPDATE"
    }
  ]
}
    Example
    {
  "result": {
    "operations": [
      {
        "id": "example",
        "type": "ORDER_RECIPIENT_UPDATE"
      }
    ]
  }
}

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR
Example
{
  "status": "OK"
}

OperationId

Идентификатор операции.

Type: string

Min length: 1

Max length: 1000

Example: example

OperationType

Тип операции:

  • ORDER_RECIPIENT_UPDATE — изменение данных получателя.

  • ORDER_DELIVERY_INTERVAL_UPDATE — изменение интервала дат доставки.

  • ORDER_STATUS_UPDATE — обновление статуса заказа для его отмены.

  • RETURN_CANCELLATION — отмена возврата.

Type: string

Enum: ORDER_RECIPIENT_UPDATE, ORDER_DELIVERY_INTERVAL_UPDATE, ORDER_STATUS_UPDATE, RETURN_CANCELLATION

OperationDTO

Информация об операции.

Name

Description

id

Type: OperationId

Идентификатор операции.

Min length: 1

Max length: 1000

Example: example

type

Type: OperationType

Тип операции:

  • ORDER_RECIPIENT_UPDATE — изменение данных получателя.

  • ORDER_DELIVERY_INTERVAL_UPDATE — изменение интервала дат доставки.

  • ORDER_STATUS_UPDATE — обновление статуса заказа для его отмены.

  • RETURN_CANCELLATION — отмена возврата.

Enum: ORDER_RECIPIENT_UPDATE, ORDER_DELIVERY_INTERVAL_UPDATE, ORDER_STATUS_UPDATE, RETURN_CANCELLATION
Example
{
  "id": "example",
  "type": "ORDER_RECIPIENT_UPDATE"
}

UpdateOrderResultDTO

Информация об операции по изменению заказа.

Name

Description

operations

Type: OperationDTO[]

Информация о запущенных операциях по изменению заказа.

Min items: 1

Example
[
  {
    "id": "example",
    "type": "ORDER_RECIPIENT_UPDATE"
  }
]
Example
{
  "operations": [
    {
      "id": "example",
      "type": "ORDER_RECIPIENT_UPDATE"
    }
  ]
}

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибках при работе с заказами

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

ApiErrorDTO

Общий формат ошибки.

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

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

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

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

Предыдущая
Получение доступных вариантов доставки
Следующая
Получение временных интервалов для изменения заказа