Работа с заказами
Просмотр / создание / изменение даты отгрузки / отмена заказа
GET: https://parts24.su/api/v1/orders/
Метод позволяет получить все существующие заказы
Пример:
curl --location "https://parts24.su/api/v1/orders/?state=new&date_from=2024-01-01&date_to=2024-01-10&sku_code=G295" \ --header "Authorization: <ВАШ КЛЮЧ API>"Параметры запроса
Передаются в строке адреса запроса в качестве GET параметров
| state | string Статус заказа |
| date_from | string Дата создания ОТ |
| date_to | string Дата создания ДО |
| sku_code | string Артикул товара в заказе |
Пример ответа
{
"status": "ok",
"data": [
{
"order_id": 15,
"order_number": 123456,
"order_contact_id": 4,
"order_create_datetime": "2021-08-10 12:39:40",
"order_update_datetime": "2021-08-10 12:39:40",
"order_state_id": "new",
"order_total": 98179.75,
"order_rate": 1,
"order_tax": 16363.29,
"order_shipping": 0,
"order_discount": 0,
"order_shipping_datetime": null,
"order_archive_datetime": null,
"order_history": [
{
"date": "2021-08-10 12:39:40",
"group": "Change of status",
"value": "Новый",
"state_id": "new",
"text": ""
}
],
"order_stock": {
"stock_id": 5,
"stock_name": "Ростов-на-Дону"
},
"order_contract": {
"contract_id": 1,
"contract_name": "Договор поставки №475 от 08.04.2015г.",
"contract_default": true,
"contract_service": false,
"contract_limit": 100000
},
"order_advertising": "RAVENOL",
"virtual": true
}
]
}
GET: https://parts24.su/api/v1/orders/{order_id}
Метод позволяет получить заказ по идентификатору
Пример:
curl --location "https://parts24.su/api/v1/orders/1/" \ --header "Authorization: <ВАШ КЛЮЧ API>"Параметры url
Передаются в строке адреса
| order_id *обязательно |
int ID заказа |
Пример ответа
{
"status": "ok",
"data": {
"order_id": 15,
"order_number": 123456,
"order_contact_id": 4,
"order_create_datetime": "2021-08-10 12:39:40",
"order_update_datetime": "2021-08-10 12:39:40",
"order_state_id": "new",
"order_total": 98179.75,
"order_rate": 1,
"order_tax": 16363.29,
"order_shipping": 0,
"order_discount": 0,
"order_shipping_datetime": null,
"order_archive_datetime": null,
"order_history": [
{
"date": "2021-08-10 12:39:40",
"group": "Change of status",
"value": "Новый",
"state_id": "new",
"text": ""
}
],
"order_stock": {
"stock_id": 5,
"stock_name": "Ростов-на-Дону"
},
"order_contract": {
"contract_id": 1,
"contract_name": "Договор поставки №475 от 08.04.2015г.",
"contract_default": true,
"contract_service": false,
"contract_limit": 100000
},
"order_advertising": "RAVENOL",
"virtual": true
}
}
PUT: https://parts24.su/api/v1/orders/
Метод позволяет создать заказ
Пример:
curl --location --request PUT "https://parts24.su/api/v1/carts/" \
--header "Content-Type: application/x-www-form-urlencoded" \
--header "Authorization: <ВАШ КЛЮЧ API>" \
--data-urlencode "cart_group_key=19.ad1d3974691bbefcf695695bf87faad2" \
--data-urlencode "zip=115583" \
--data-urlencode "country_code=rus" \
--data-urlencode "region_code=77" \
--data-urlencode "city=Санкт-Петербург" \
--data-urlencode "street=Магнитогорская" \
--data-urlencode "home=30"
--data-urlencode "room=516"
Параметры тела запроса
Передаются в теле запроса в виде x-www-form-urlencoded
| cart_group_key *обязательно |
string Ключ группы корзины Можно получить из метода /api/v1/carts/{cart_id} |
| zip *обязательно |
string Индекс |
| country_code *обязательно |
string Код страны Можно получить из метода /api/v1/countries/ |
| region_code *обязательно |
string Код региона Можно получить из метода /api/v1/regions/ |
| city *обязательно |
string Город |
| street *обязательно |
string Улица |
| home *обязательно |
string Номер дома |
| room | string Номер помещения |
Пример ответа
{
"status": "ok",
"data": {
"created_order_id": 40
}
}
PATCH: https://parts24.su/api/v1/orders/{order_id}
Метод позволяет изменять дату отгрузки заказа
Пример:
curl --location --request PATCH "https://parts24.su/api/v1/carts/1/" \
--header "Content-Type: application/x-www-form-urlencoded" \
--header "Authorization: <ВАШ КЛЮЧ API>" \
--data-urlencode "shipping_date=2024-02-01"
Параметры url
Передаются в строке адреса
| order_id *обязательно |
int ID заказа |
Параметры тела запроса
Передаются в теле запроса в виде x-www-form-urlencoded
| shipping_date *обязательно |
string Новая дата отгрузки |
Пример ответа
{
"status": "ok",
"data": {
"order_id": 15,
"order_number": 123456,
"order_contact_id": 4,
"order_create_datetime": "2021-08-10 12:39:40",
"order_update_datetime": "2021-08-10 12:39:40",
"order_state_id": "new",
"order_total": 98179.75,
"order_rate": 1,
"order_tax": 16363.29,
"order_shipping": 0,
"order_discount": 0,
"order_shipping_datetime": null,
"order_archive_datetime": null,
"order_history": [
{
"date": "2021-08-10 12:39:40",
"group": "Change of status",
"value": "Новый",
"state_id": "new",
"text": ""
}
],
"order_stock": {
"stock_id": 5,
"stock_name": "Ростов-на-Дону"
},
"order_contract": {
"contract_id": 1,
"contract_name": "Договор поставки №475 от 08.04.2015г.",
"contract_default": true,
"contract_service": false,
"contract_limit": 100000
},
"order_advertising": "RAVENOL",
"virtual": true
}
}
DELETE: https://parts24.su/api/v1/orders/{order_id}
Метод позволяет отменить заказ
Пример:
curl --location --request DELETE "https://parts24.su/api/v1/orders/1/" \
--header "Authorization: <ВАШ КЛЮЧ API>" \
Параметры url
Передаются в строке адреса
| order_id *обязательно |
int ID заказа |
Пример ответа
{
"status": "ok",
"data": {
"order_id": 10077,
"order_number": null,
"order_create_datetime": "2024-01-17 11:04:55",
"order_update_datetime": "2024-01-17 18:03:27",
"order_value": "Заявка на отмену",
"order_state_id": "zayavka-na-otmen",
"order_total": 23891.18,
"order_rate": 1,
"order_tax": 3981.86,
"order_shipping": 0,
"order_discount": 0,
"order_shipping_datetime": null,
"order_archive_datetime": null,
"order_history": [
{
"date": "2024-01-17 15:03:27",
"group": "Change of status",
"value": "Заявка на отмену",
"state_id": "zayavka-na-otmen",
"text": ""
},
{
"date": "2024-01-17 08:04:55",
"group": "Change of status",
"value": "Новый",
"state_id": "new",
"text": ""
}
],
"order_stock": {
"stock_id": 5,
"stock_name": "Ростов-на-Дону"
},
"order_contract": null,
"order_advertising": null,
"virtual": false
}
}