Получение временных интервалов для изменения заказа

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

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

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

Возвращает список доступных интервалов для изменения даты и времени курьерской доставки.

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

Request

POST

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

Path parameters

Name

Description

campaignId

Type: integer

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

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

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

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

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

Min value: 1

Body

application/json
{
  "id": 0
}

Name

Description

id

Type: integer

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

OrderUpdateOptionType

Тип изменения заказа:

  • UPDATE_DELIVERY_INTERVAL — изменение интервала курьерской доставки.

Type: string

Default: UPDATE_DELIVERY_INTERVAL

Const: UPDATE_DELIVERY_INTERVAL

Responses

200 OK

Список доступных интервалов.

Body

application/json
{
  "status": "OK",
  "result": {
    "deliveryIntervals": {
      "availableDeliveryIntervals": [
        {}
      ]
    }
  }
}

Type: object

All of 2 types
  • Type: ApiResponse

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

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

    result

    Type: OrderUpdateOptionsDTO

    Список доступных интервалов.

    Example
    {
      "deliveryIntervals": {
        "availableDeliveryIntervals": [
          {
            "deliveryDateInterval": {
              "fromDate": "2025-01-01",
              "toDate": "2025-01-01"
            },
            "deliveryTimeInterval": {
              "fromTime": "example",
              "toTime": "example"
            }
          }
        ]
      }
    }
    
    Example
    {
      "result": {
        "deliveryIntervals": {
          "availableDeliveryIntervals": [
            {
              "deliveryDateInterval": {},
              "deliveryTimeInterval": {}
            }
          ]
        }
      }
    }
    

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

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

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

Example
{
  "status": "OK"
}

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

DeliveryIntervalsUpdateOptionsDTO

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

Возвращается только для типа изменения UPDATE_DELIVERY_INTERVAL.

Name

Description

availableDeliveryIntervals

Type: DeliveryIntervalsUpdateOptionDTO[]

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

Если доступных интервалов нет, возвращается пустой массив.

Min items: 0

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

OrderUpdateOptionsDTO

Список доступных интервалов.

Name

Description

deliveryIntervals

Type: DeliveryIntervalsUpdateOptionsDTO

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

Возвращается только для типа изменения UPDATE_DELIVERY_INTERVAL.

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

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.