POST split/orders/list

Позволяет получить список заказов.

Формат запроса

POST https://apiauto.ru/1.0/split/orders/list

Заголовки запроса

Заголовок

Описание

x-external-dealer-id

Идентификатор клиента из Авто.ру Бизнес.

x-authorization

Ключ API.

Формат тела запроса


   {
     "filter": {
       "phone_or_order_number": "string"
     },
     "sorting": "string",
     "pagination": {
       "page": "integer",
       "page_size": "integer"
     }
   }

filter*

Фильтр для выбора заказов.

Допустимые значения:

phone_or_order_number – фильтрация по номеру телефона или номеру заказа в системе.

sorting*

Сортировка заказов.

Допустимые значения:
  • NO_SORTING – без сортировки;
  • DATE_CREATED_ASC – сортировка по дате создания (по возрастанию);
  • DATE_CREATED_DESC – сортировка по дате создания (по убыванию).

pagination*

Нумерация страниц.

page*

Номер страницы.

page_size*

Количество элементов на странице.

* Обязательный параметр

Общая структура ответа приведена ниже. Порядок следования элементов не гарантируется. В структуре могут присутствовать служебные параметры, которые не описаны в таблице.

Формат ответа


  {
    "orders": [
      {
      "created_at": "string",
        "status": "string",
        "order_id": "string",
        "user_phone": "string",
        "cart": [
          {
            "product_id": "string",
            "service_name": "string",
            "quantity": "integer",
            "price_per_item": "integer"
          }
        ],
        "total_price": "integer",
        "tax": "integer",
        "payment_url": "string",
        "error_message": "string",
        "refund_info": {
          "total_refunded_amount": "integer",
          "refunded_cart": [
            {
              "product_id": "string",
              "refunded_quantity": "integer",
              "refunded_amount": "integer",
              "service_name": "string"
            }
        ]
      },
      "car_info": {
        "vin": "string",
        "mileage": "integer"
      }
    }
  ],
  "pagination": {
    "page_num": "integer",
    "page_size": "integer",
    "total_count": "integer",
    "total_page_count": "integer"
  },
  "error": "string",
  "status": "string",
  "detailed_error": "string"
}

orders*

Список найденных заказов.

created_at*

Время создания заказа.

status*

Статус заказа.

Значения:
  • NEW – новый;
  • CREATED – получена ссылка на оплату;
  • PAID – оплачен;
  • REFUNDED – возврат;
  • CANCELED – отменен;
  • FAILED – ошибка.

order_id*

Номер заказа, идентификатор в системе.

user_phone*

Номер телефона клиента (пример: +79997775533).

cart*

Актуальное состояние корзины.

product_id

Идентификатор продукта в системе.

service_name*

Предоставляемая услуга/товар.

quantity*

Количество единиц предоставляемой услуги/товаров.

price_per_item*

Цена за единицу предоставляемой услуги/товаров в рублях.

total_price*

Актуальная стоимость заказа.

tax*

Ставка НДС.

Значения:
  • NDS_20 – НДС по ставке 20%;
  • NDS_10 – НДС по ставке 10%;
  • NDS_20_120 – НДС по расчетной ставке 20/120;
  • NDS_10_110 – НДС по расчетной ставке 10/110;
  • NDS_0 – НДС по ставке 0%;
  • NO_NDS – Без НДС.

payment_url*

Ссылка на оплату заказа.

error_message

Сообщение об ошибке.

refund_info

Информация о возврате.

total_refunded_amount*

Сумма возврата.

refunded_cart*

Список возвращенных товаров.

product_id

Идентификатор продукта в системе.

refunded_quantity*

Количество возвращенных единиц предоставляемой услуги/товаров.

refunded_amount*

Сумма подлежащая возврату для предоставляемой услуги/товаров в рублях.

service_name*

Предоставляемая услуга/товар.

car_info*

Информация об обслуживаемом автомобиле.

vin

Идентификационный номер ТС.

mileage

Пробег в километрах.

pagination*

Нумерация страниц.

page_num*


page_size*

Количество элементов на странице.

total_count*

Общее количество найденных элементов.

total_page_count*

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

* Обязательный параметр

Коды ответа

Код

Причина

Описание

200

OK

Успешный запрос.

400

BAD_REQUEST

Синтаксическая ошибка в запросе.

500

INTERNAL SERVER ERROR

Внутренняя ошибка сервера.

Пример

Запрос:

curl -i -X POST 'https://apiauto.ru/1.0/split/orders/list
     
     {
       "filter": {
         "phone_or_order_number": "string"
       },
       "sorting": "NO_SORTING",
       "pagination": {
         "page": 1,
         "page_size": 10
       }
     }

Ответ:

HTTP/1.1 200 OK
     Server: nginx
     Date: Fri, 1 Mar 2024 19:46:58 GMT
     Content-Type: application/json
     Connection: keep-alive
     
     {
       "orders": [
         {
           "created_at": "2024-01-24T06:29:11.519Z",
           "status": "NEW",
           "order_id": "string",
           "user_phone": "string",
           "cart": [
             {
               "product_id": "string",
               "service_name": "string",
               "quantity": 0,
               "price_per_item": 0
             }
           ],
           "total_price": 0,
           "tax": "NDS_20",
           "payment_url": "string",
           "error_message": "string",
           "refund_info": {
             "total_refunded_amount": 0,
             "refunded_cart": [
               {
                 "product_id": "string",
                 "refunded_quantity": 0,
                 "refunded_amount": 0,
                 "service_name": "string"
               }
             ]
           },
           "car_info": {
             "vin": "string",
             "mileage": 0
           }
         }
       ],
       "pagination": {
         "page_num": 1,
         "page_size": 10,
         "total_count": 1,
         "total_page_count": 1
       },
       "error": "UNKNOWN_ERROR",
       "status": "SUCCESS",
       "detailed_error": "string"
     }

* Обязательный параметр

Предыдущая
POST split/order/refund
Следующая
Чаты