Клиентские возвраты
Метод предназначен для оформления клиентских возвратов для интернет-магазинов.
Клиентский возврат — это возврат, который оформляет сам клиент уже после вручения заказа. Отличие от обычного возврата в конечном статусе прямого заказа:
у клиентских возвратов конечный статус "вручен" и возврат оформляет сам клиент, у обычных возвратов, конечный статус "Не вручен" и возврат оформляется СДЭКом. Для частично врученных заказов можно оформить и клиентский возврат и обычный возврат.
(клиентский возврат создается только для заказов интернет-магазина в конечном статусе "Вручен")
Запрос на регистрацию клиентского возврата
Для использования необходимо отправить POST-запрос на URL:
Среда | URL |
|---|---|
| тестовая | https://api.edu.cdek.ru/v2/orders/{order_uuid}/clientReturn |
| боевая | https://api.cdek.ru/v2/orders/{order_uuid}/clientReturn |
{order_uuid} - идентификатор прямого заказа в ИС СДЭК, для которого будет создаваться клиентский возврат
Этот метод используется в случае, если прямой заказ доставлялся СДЭК и получатель хочет вернуть его полностью.
Если прямой заказ доставлялся другой курьерской службой, либо по прямому заказу нужно вернуть не все товары, то необходимо использовать метод "Регистрация заказа" (https://api-docs.cdek.ru/29923926.html), передав признак is_client_return = true.
Тело запроса
Необходимо передавать в формате JSON (Content-Type: application/json).
Поддерживается следующее поле:
Название поля | Описание | Тип поля | Обязательно для заполнения |
|---|---|---|---|
| tariff_code | Код тарифа. Использовать тарифы, которые прописаны в договоре. | integer | да |
Ответ на регистрацию заказа
Ответ возвращается в формате JSON:
№ | Название поля | Описание | Тип поля | Обяз. для заполн. |
|---|---|---|---|---|
| 1 | entity | Информация о заказе | entity | нет |
| 1.1 | uuid1 | Идентификатор прямого заказа в ИС СДЭК | UUID | нет |
| 2 | requests | Информация о запросе над заказом | request[] | да |
| 2.1 | request_uuid | Идентификатор запроса в ИС СДЭК | UUID | нет |
| 2.2 | type | Тип запроса Может принимать значения: CREATE_CLIENT_RETURN | 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() | да |
uuid1 - для просмотра возвратного заказа необходимо сделать запрос по прямому заказу и там получить информацию по возврату (по связанной сущности).
Подробнее в разделе "Информация о заказе", п. 3.1, 3.2 и 3.4, ответы на получение информации по Клиентским возвратам.
Возвращение информации по связанной сущности:
• uuid -Идентификатор сущности, связанной с заказом
• type - тип сущности, может принимать значения:
"client_return_order" - заказ на клиентский возврат (возвращается для прямого заказа, к которому привязан клиентский возврат);
"client_direct_order" - прямой заказ, по которому оформлен клиентский возврат
• cdek_number - номер заказа СДЭК, может возвращаться для "client_return_order" и "client_direct_order"
Пример:
{
"uuid": "72757777-6002-4a77-af00-180c751305fz",
"type": "client_return_order",
"cdek_number": "1100000001"
} |
{
"tariff_code": 139
} |
{
"entity": {
"uuid": "72753031-5dad-4760-9580-eb869062550c"
},
"requests": [
{
"request_uuid": "0323a5ab-157e-4dbb-a08d-9ec8728a2260",
"type": "CREATE_CLIENT_RETURN",
"date_time": "2022-12-02T01:31:28+0000",
"state": "ACCEPTED"
}
]
} |
{
"entity": {
"uuid": "72753031-5dad-4760-9580-eb869062550c",
"type": 1,
"is_return": false,
"is_reverse": false,
"cdek_number": "1108051973",
"number": "1669944608",
"tariff_code": 139,
"comment": "Новый заказ",
"items_cost_currency": "RUB",
"recipient_currency": "RUB",
"sender": {
"company": "Pogoda",
"name": "Петров Илья",
"email": "msk@cdek.ru",
"phones": [
{
"number": "79999999999",
"additional": "1234"
}
],
"passport_requirements_satisfied": false
},
"seller": {
"name": "Петров Илья",
"phone": "+79999999999",
"ownership_form": "4",
"address": "Новосибирск, Ленина 1"
},
"recipient": {
"company": "Иванов Иван",
"name": "Иванов Иван",
"passport_series": "5008",
"passport_number": "345123",
"passport_date_of_issue": "2019-03-12",
"passport_organization": "ОВД Москвы",
"tin": "123546789",
"email": "pochta@gmail.com",
"phones": [
{
"number": "79977777777",
"additional": "123"
}
],
"passport_requirements_satisfied": false
},
"from_location": {
"code": 270,
"city": "Новосибирск",
"fias_guid": "8dea00e3-9aab-4d8e-887c-ef2aaa546456",
"country_code": "RU",
"country": "Россия",
"region": "Новосибирская область",
"region_code": 23,
"longitude": 82.906928,
"latitude": 55.028739,
"address": "Новосибирск, Большевистская 101"
},
"to_location": {
"code": 44,
"city": "Москва",
"fias_guid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"country_code": "RU",
"country": "Россия",
"region": "Москва",
"region_code": 81,
"longitude": 37.622513,
"latitude": 55.75322,
"address": "ул. Блюхера, 32"
},
"services": [
{
"code": "INSURANCE",
"parameter": "300.00",
"sum": 2.25
},
{
"code": "AGENT_COMMISSION",
"sum": 35.00
},
{
"code": "CASH_ON_DELIVERY",
"sum": 0
}
],
"packages": [
{
"number": "bar-001",
"weight": 4000,
"length": 10,
"width": 10,
"weight_volume": 200,
"weight_calc": 4000,
"height": 10,
"comment": "приложена опись",
"items": [
{
"name": "Товар",
"ware_key": "00055",
"marking": "0104630095188367217<GY>No;wZOE5",
"payment": {
"value": 3000.0,
"vat_sum": 0.0
},
"weight": 700,
"weight_gross": 700,
"amount": 1,
"delivery_amount": 1,
"name_i18n": "www.item.ru",
"url": "www.item.ru",
"cost": 300.0
}
],
"package_id": "ad73dfba-2848-46a6-b49f-7731bed3c37f"
}
],
"statuses": [
{
"code": "DELIVERED",
"name": "Вручен",
"date_time": "2022-12-02T01:31:05+0000",
"city": "Офис СДЭК"
},
{
"code": "CREATED",
"name": "Создан",
"date_time": "2022-12-02T01:30:10+0000",
"city": "Офис СДЭК"
},
{
"code": "ACCEPTED",
"name": "Принят",
"date_time": "2022-12-02T01:30:09+0000",
"city": "Офис СДЭК"
}
],
"is_client_return": false,
"delivery_mode": "1",
"delivery_date": "2022-12-02",
"delivery_detail": {
"date": "2022-12-02",
"recipient_name": "Иванов Иван",
"payment_sum": 3500.0,
"delivery_sum": 257,
"total_sum": 323.68,
"payment_info": []
},
"calls": {}
},
"requests": [
{
"request_uuid": "0323a5ab-157e-4dbb-a08d-9ec8728a2260",
"type": "CREATE_CLIENT_RETURN",
"date_time": "2022-12-02T01:31:28+0000",
"state": "SUCCESSFUL"
},
{
"request_uuid": "b6aa99cb-c66d-47bd-a0d1-55f138691b59",
"type": "CREATE",
"date_time": "2022-12-02T01:30:09+0000",
"state": "SUCCESSFUL"
}
],
"related_entities": [
{
"uuid": "72753031-6002-4b75-af00-180c751305fc",
"type": "client_return_order",
"cdek_number": "1108051974"
}
]
} |
Пример запроса с ошибкой по прямому заказу:
{
"entity": {
"uuid": "72753031-f307-4869-ad9f-1a1520dcc82f",
"type": 1,
"is_return": false,
"is_reverse": false,
"cdek_number": "1108051975",
"number": "1669944871",
"tariff_code": 139,
"comment": "Новый заказ",
"items_cost_currency": "RUB",
"recipient_currency": "RUB",
"sender": {
"company": "Pogoda",
"name": "Петров Илья",
"email": "msk@cdek.ru",
"phones": [
{
"number": "79999999999",
"additional": "1234"
}
],
"passport_requirements_satisfied": false
},
"seller": {
"name": "Петров Илья",
"phone": "+79999999999",
"ownership_form": "4",
"address": "Новосибирск, Ленина 1"
},
"recipient": {
"company": "Иванов Иван",
"name": "Иванов Иван",
"passport_series": "5008",
"passport_number": "345123",
"passport_date_of_issue": "2019-03-12",
"passport_organization": "ОВД Москвы",
"tin": "123546789",
"email": "pochta@gmail.com",
"phones": [
{
"number": "79977777777",
"additional": "123"
}
],
"passport_requirements_satisfied": false
},
"from_location": {
"code": 270,
"city": "Новосибирск",
"fias_guid": "8dea00e3-9aab-4d8e-887c-ef2aaa546456",
"country_code": "RU",
"country": "Россия",
"region": "Новосибирская область",
"region_code": 23,
"longitude": 82.906928,
"latitude": 55.028739,
"address": "Новосибирск, Большевистская 101"
},
"to_location": {
"code": 44,
"city": "Москва",
"fias_guid": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5",
"country_code": "RU",
"country": "Россия",
"region": "Москва",
"region_code": 81,
"longitude": 37.622513,
"latitude": 55.75322,
"address": "ул. Блюхера, 32"
},
"services": [
{
"code": "INSURANCE",
"parameter": "300.00",
"sum": 2.25
}
],
"packages": [
{
"number": "bar-001",
"weight": 4000,
"length": 10,
"width": 10,
"weight_volume": 200,
"weight_calc": 4000,
"height": 10,
"comment": "приложена опись",
"items": [
{
"name": "Товар",
"ware_key": "00055",
"marking": "0104630095188367217<GY>No;wZOE5",
"payment": {
"value": 3000.0,
"vat_sum": 0.0
},
"weight": 700,
"weight_gross": 700,
"amount": 1,
"delivery_amount": 0,
"name_i18n": "www.item.ru",
"url": "www.item.ru",
"cost": 300.0
}
],
"package_id": "edfe971b-5894-4e92-a964-5b362930ed75"
}
],
"statuses": [
{
"code": "CREATED",
"name": "Создан",
"date_time": "2022-12-02T01:34:32+0000",
"city": "Офис СДЭК"
},
{
"code": "ACCEPTED",
"name": "Принят",
"date_time": "2022-12-02T01:34:31+0000",
"city": "Офис СДЭК"
}
],
"is_client_return": false,
"delivery_mode": "1",
"delivery_detail": {
"delivery_sum": 257,
"total_sum": 285.18,
"payment_info": []
},
"calls": {}
},
"requests": [
{
"request_uuid": "2e36a0d1-1f7e-4421-aaa6-0cb1c9e437bc",
"type": "CREATE_CLIENT_RETURN",
"date_time": "2022-12-02T01:34:49+0000",
"state": "INVALID",
"errors": [
{
"code": "ev_crb_status_not_delivery",
"message": "(eng) Заказ из которого создается клиентский возврат еще не был вручен"
}
]
},
{
"request_uuid": "4c5c09e5-85c7-418a-a9ff-22c4546ca5af",
"type": "CREATE",
"date_time": "2022-12-02T01:34:31+0000",
"state": "SUCCESSFUL"
}
]
} |
Информацию по возвратному заказу получаем из прямого заказа в связанных сущностях (related_entities) |
© 2000—2024, Курьерская компания СДЭК