Изменение заказа
Метод используется для изменения созданного ранее заказа.
Условием возможности изменения заказа является отсутствие движения груза на складе СДЭК (т.е. статус заказа «Создан»).
Запрос на изменение заказа
Для использования необходимо отправить PATCH-запрос на URL:
Среда | URL |
---|---|
тестовая | https://api.edu.cdek.ru/v2/orders |
боевая | https://api.cdek.ru/v2/orders |
Тело запроса
Необходимо передавать в формате JSON (Content-Type: application/json).
Поддерживаются следующие поля:
№ | Тэг/Атрибут | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | uuid1 | Идентификатор заказа в ИС СДЭК, который нужно изменить | UUID | да, если не заполнен cdek_number |
2 | cdek_number1 | Номер заказа СДЭК, который нужно изменить | long | да, если не заполнен uuid |
3 | tariff_code2 | Код тарифа (режимы старого и нового тарифа должны совпадать) | integer | нет |
4 | comment | Комментарий к заказу | string(255) | нет |
5 | shipment_point | Код ПВЗ СДЭК, на который будет производится забор отправления либо самостоятельный привоз клиентом Не может использоваться одновременно с from_location | string() | нет |
6 | delivery_point | Код ПВЗ СДЭК, на который будет доставлена посылка Не может использоваться одновременно с to_location | string() | нет |
7 | delivery_recipient_cost | Доп. сбор за доставку, которую ИМ берет с получателя. Валюта сбора должна совпадать с валютой наложенного платежа. | money | нет |
7.1 | value | Сумма дополнительного сбора | float | да |
7.2 | vat_sum | Сумма НДС | float | нет |
7.3 | vat_rate | Ставка НДС (значение - 0, 10, 12, 20, null - нет НДС) | integer | нет |
8 | delivery_recipient_cost_adv | Доп. сбор за доставку (которую ИМ берет с получателя), в зависимости от суммы заказа Возможно указать несколько порогов | threshold[] | нет |
8.1 | threshold | Порог стоимости товара (действует по условию меньше или равно), в целых единицах валюты | integer | да |
8.2 | sum | Доп. сбор за доставку товаров, общая стоимость которых попадает в интервал | float | да |
8.3 | vat_sum | Сумма НДС включённая в доп. сбор за доставку | float | нет |
8.4 | vat_rate | Ставка НДС (значение - 0, 10, 12, 20, null - нет НДС) | integer | нет |
9 | sender | Отправитель | contact | нет |
9.1 | company | Название компании | string(255) | нет |
9.2 | name | ФИО контактного лица | string(255) | нет |
9.3 | Эл. адрес Должен соответствовать RFC 2822 | string(255) | нет | |
9.4 | passport_series | Серия паспорта | string(4) | нет |
9.5 | passport_number | Номер паспорта | string(30) | нет |
9.6 | passport_date_of_issue | Дата выдачи паспорта | date (yyyy-MM-dd) | нет |
9.7 | passport_organization | Орган выдачи паспорта | string(255) | нет |
9.8 | tin | ИНН Может содержать 10, либо 12 символов | string(12) | нет |
9.9 | passport_date_of_birth | Дата рождения | date (yyyy-MM-dd) | нет |
9.10 | phones | Список телефонов Не более 10 номеров | phone[] | нет |
9.10.1 | number* | Номер телефона | string(255) | да |
9.10.2 | additional | Дополнительная информация (доп. номер) | string(255) | нет |
10 | seller | Реквизиты реального продавца | seller | нет |
10.1 | name | Наименование истинного продавца | string(255) | нет |
10.2 | inn | ИНН истинного продавца | string(12) | нет |
10.3 | phone* | Телефон истинного продавца | string(255) | нет |
10.4 | ownership_form | Код формы собственности | integer | нет |
11 | recipient | Получатель | contact | нет |
11.1 | company | Название компании | string(255) | нет |
11.2 | name | ФИО контактного лица | string(255) | нет |
11.3 | passport_series | Серия паспорта | string(4) | нет |
11.4 | passport_number | Номер паспорта | string(30) | нет |
11.5 | passport_date_of_issue | Дата выдачи паспорта | date (yyyy-MM-dd) | нет |
11.6 | passport_organization | Орган выдачи паспорта | string(255) | нет |
11.7 | tin | ИНН Может содержать 10, либо 12 символов | string(12) | нет |
11.8 | passport_date_of_birth | Дата рождения | date (yyyy-MM-dd) | нет |
11.9 | Эл. адрес Должен соответствовать RFC 2822 | string(255) | нет | |
11.10 | phones | Список телефонов | phone[] | нет |
11.10.1 | number* | Номер телефона Должен передаваться в международном формате: код страны (для России +7) и сам номер (10 и более цифр) | string(255) | да |
11.10.2 | additional | Дополнительная информация (доп. номер) | string(255) | нет |
12 | to_location2 | Адрес получения Не может использоваться одновременно с delivery_point | location | нет |
12.1 | code | Код населенного пункта СДЭК (метод "Список населенных пунктов") | integer | нет |
12.2 | fias_guid | Уникальный идентификатор ФИАС | UUID | нет |
12.3 | postal_code | Почтовый индекс | string(255) | нет |
12.4 | longitude | Долгота | float | нет |
12.5 | latitude | Широта | float | нет |
12.6 | country_code | Код страны в формате ISO_3166-1_alpha-2 (по умолчанию RU) | string(2) | нет |
12.7 | region | Название региона | string(255) | нет |
12.8 | region_code | Код региона (справочник СДЭК) | integer | нет |
12.9 | sub_region | Название района региона | string(255) | нет |
12.10 | city | Название города | string(255) | нет |
12.11 | kladr_code | Код КЛАДР Устаревшее поле | string(255) | нет |
12.12 | address | Строка адреса | string(255) | да |
13 | from_location | Адрес отправки Не может использоваться одновременно с shipment_point | location | нет |
13.1 | address | Строка адреса | string(255) | нет |
14 | services2 | Дополнительные услуги | service[] | нет |
14.1 | code | Тип дополнительной услуги | integer | да |
14.2 | parameter | Параметр дополнительной услуги:
| integer | нет |
15 | packages2 | Список информации по местам (упаковкам) Не переданные упаковки будут удалены | package[] | нет |
15.1 | package_id | Уникальный номер упаковки в ИС СДЭК | string | нет, если передается новая упаковка (с новым number) |
15.2 | number | Номер упаковки (можно использовать порядковый номер упаковки заказа или номер заказа), уникален в пределах заказа. Идентификатор заказа в ИС Клиента | string(20) | да |
15.3 | weight | Общий вес (в граммах) | integer | да |
15.4 | length | Габариты упаковки. Длина (в сантиметрах) | integer | да, если указаны остальные габариты |
15.5 | width | Габариты упаковки. Ширина (в сантиметрах) | integer | да, если указаны остальные габариты |
15.6 | height | Габариты упаковки. Высота (в сантиметрах) | integer | да, если указаны остальные габариты |
15.7 | comment | Комментарий к упаковке Только для заказа типа "доставка" | string(255) | нет |
15.8 | items | Позиции товаров в упаковке Только для заказов "интернет-магазин" | item[] | да |
15.8.1 | name | Наименование товара (может также содержать описание товара: размер, цвет) | string(255) | да |
15.8.2 | ware_key | Идентификатор/артикул товара Артикул товара может содержать только символы: [A-z А-я 0-9 ! @ " # № $ ; % ^ : & ? * () _ - + = ? < > , .{ } [ ] \ / , пробел] При передаче одинаковых артикулов в рамках одной упаковки, артикул будет заменяться на: {ware_key}_1, {ware_key}_2 и так далее. | string(50) | да |
15.8.3 | marking | Маркировка товара Для корректного отображения маркировки товара в чеке требуется передавать 1) Код товара в формате GS1 Пример: 010468008549838921AAA0005255832GS91EE06GS92VTwGVc7wKCc2tqRncUZ1RU5LeUKSXjWbfNQOpQjKK+A 2) Последовательность допустимых символов общей длиной в 29 символов. Пример: 00000046198488X?io+qCABm8wAYa 3) Меховые изделия. Имеют собственный формат. Пример: RU-430302-AAA7582720 | string() | нет |
15.8.4 | payment | Оплата за товар при получении (за единицу товара в указанной валюте, значение >=0) — наложенный платеж, в случае предоплаты значение = 0 | money | да |
15.8.4.1 | value | Сумма наложенного платежа (в случае предоплаты = 0) | float | да |
15.8.4.2 | vat_sum | Сумма НДС | float | нет |
15.8.4.3 | vat_rate | Ставка НДС (значение - 0, 10, 12, 20, null - нет НДС) | integer | нет |
15.8.5 | cost | Объявленная стоимость товара (за единицу товара в указанной валюте, значение >=0). С данного значения рассчитывается страховка | float | да |
15.8.6 | weight | Вес (за единицу товара, в граммах) | integer | да |
15.8.7 | weight_gross | Вес брутто | integer | да, если заказ - международный |
15.8.8 | amount | Количество единиц товара (в штуках) Количество одного товара в заказе может быть от 1 до 999 | integer | да |
15.8.9 | name_i18n | Наименование на иностранном языке | string(255) | нет |
15.8.10 | brand | Бренд на иностранном языке | string(255) | нет |
15.8.11 | country_code | Код страны в формате ISO_3166-1_alpha-2 | string(2) | нет |
15.8.12 | material | Код материала | string(255) | нет |
15.8.13 | wifi_gsm | Содержит wifi/gsm | boolean | нет |
15.8.14 | url | Ссылка на сайт интернет-магазина с описанием товара | string(255) | нет |
1 Идентификация заказа происходит по указанным полям (в приоритете uuid).
2 Возможен пересчет стоимости заказа при передаче новых значений в указанных полях.
(*) • Номер телефона отправителя (9.10.1) валидируется на соответствие формату телефонов в стране отправителя (телефонный код, количество символов).
Исключение: если телефон не соответствует формату страны отправителя, но соответствует формату телефонов России, Казахстана, Китая или Малазии, заказ будет зарегистрирован успешно.
• Номер телефона получателя (11.10.1) валидируется на соответствие формату телефонов в стране получателя (телефонный код, количество символов).
Исключение: если телефон не соответствует формату страны отправителя, но соответствует формату телефонов России, Казахстана, Китая или Малазии, заказ будет зарегистрирован успешно.
• Номер телефона продавца (10.3) валидируется на соответствие формату телефонов в стране получателя (телефонный код, количество символов), а также соответствие кода оператора пулу номеров активных телефонных операторов.
Ответ на изменение заказа
Ответ возвращается в формате JSON:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
---|---|---|---|---|
1 | entity | Информация о заказе | entity | нет |
1.1 | uuid | Идентификатор заказа в ИС СДЭК, который был изменен | UUID | нет |
2 | requests | Информация о запросе над заказом | request[] | да |
2.1 | request_uuid | Идентификатор запроса в ИС СДЭК | UUID | нет |
2.2 | type | Тип запроса Может принимать значения: CREATE, UPDATE, DELETE, AUTH, GET | string() | да |
2.3 | date_time | Дата и время установки текущего состояния запроса (формат yyyy-MM-dd'T'HH:mm:ssZ) | datetime | да |
2.4 | state | Текущее состояние запроса ACCEPTED - пройдена предварительная валидация и запрос принят | string() | да |
2.5 | errors | Ошибки, возникшие в ходе выполнения запроса | error[] | нет |
2.5.1 | code | Код ошибки | string() | да |
2.5.2 | message | Описание ошибки | string() | да |
2.6 | warnings | Предупреждения, возникшие в ходе выполнения запроса | warning[] | нет |
2.6.1 | code | Код предупреждения | string() | да |
2.6.2 | message | Описание предупреждения | string() | да |
{ "uuid":"72753031-5427-4d1b-b1e4-7c4c26be00a0", "cdek_number":"1105660806", "tariff_code":"10", "sender":{ "company":"Pogoda", "name":"Петров Петр", "email":"react@cdek.ru", "phones":[ { "number":"+79134637228", "additional":"1234" } ] }, "recipient":{ "company":"NUMM", "name":"Константинов Константин", "email":"pochta@gmail.com", "phones":[ { "number":"+79134635628", "additional":"123" } ] }, "to_location":{ "code":"137" }, "from_location":{ "address":"Новосибирск, Большевистская 101" }, "services":[ { "code":"DANGER_CARGO" }, { "code":"PACKAGE_1", "parameter":"1" } ], "packages":[ { "number":"bar-666", "height":20, "length":20, "weight":4000, "width":20, "items":[ { "name":"Товар", "ware_key":"00055", "payment":{ "value":3000 }, "cost":300, "amount":1, "weight":700 } ] } ] } |
{ "entity": { "uuid": "72753031-5427-4d1b-b1e4-7c4c26be00a0" }, "requests": [ { "request_uuid": "72753031-35cc-4ef6-a353-25a09d3a973a", "type": "UPDATE", "state": "ACCEPTED", "date_time": "2020-01-23T11:48:40Z", "errors": [], "warnings": [ { "code": "v2_cost_change_by_tariff", "message": "New tariff code can trigger change order cost" }, { "code": "v2_cost_change_by_services", "message": "New services can trigger change order cost" }, { "code": "v2_cost_change_by_parameters", "message": "New parameters (weight, dimensions, items cost) can trigger change order cost" } ] } ] } |
© 2000—2024, Курьерская компания СДЭК