Получение списка всех заказов

Список заказов

get

Этот эндпоинт возвращает список заказов продавца с информацией, включающей идентификатор заказа, статус, общую сумму, способ оплаты, срок рассрочки, а также дату и время создания заказа. Кроме того, он предоставляет информацию о клиенте, включая фамилию, имя и номер телефона, а также адрес и город доставки заказа. Для получения указанной информации необходимо указать обязательные параметры для фильтрации запроса, такие как статус и начальная дата поиска заказа. Учитывая возможное большое количество заказов, ответ на запрос может состоять из нескольких страниц. Вам нужно указать в параметрах номер страницы (page_number), которую хотите получить, а также количество результатов запроса на одной странице (page_size).

Входные параметры запроса:

Название	Описание	Пример
page_number*	Номер страницы, начинается с 0	1
page_size*	Количество результатов запроса, максимальное значение — 1000	15
status*	Статус заказа. Возможные значения: APPROVED_BY_BANK — Оплачено ACCEPTED_BY_MERCHANT — Принято продавцом COMPLETED — Доставлено CANCELED_BY_MERCHANT — Отменён продавцом READY_FOR_DELIVERY — Готов к доставке TO_RETURN — На возврат RETURNED — Возвращён RETURNED_PARTIAL — Частично возвращён IN_SHIPPING — Доставляется	APPROVED_BY_BANK
created_from*	Начальная дата поиска заказа в формате Unix timestamp	1576139970
created_to	Конечная дата поиска заказа в формате Unix timestamp	1576139970
order_source	Тип заказа. Возможные значения: Маркетплейс, QR Lite, QR Tole	Маркетплейс
Выходные параметры ответа:

Название	Описание	Пример
order_id	Идентификатор заказа	1187381
status	Статус заказа	COMPLETED
total_price	Общая сумма заказа	12990.00
phone	Номер телефона клиента	[phone]
firstname	Имя клиента	Тогжан
lastname	Фамилия клиента	Салим
payment_mode	Способ оплаты: PAY_WITH_CREDIT, PREPAID	PAY_WITH_CREDIT
order_source	Источник заказа: Веб, Маркетплейс, QR, QR Lite	Веб
installment_term	Срок рассрочки/кредита (в мес.)	6
created_at	Дата и время создания заказа	2022-06-18 12:10:15
delivery_mode	Способ доставки: JPOST, Своя доставка, Самовывоз	JPOST
delivery_date	Интервал доставки	17.11.2023, 10:00 - 14:00
commission_cpo	Стоимость доставки для мерча	120
commission	Комиссия (%)	16.7
commission_amount	Сумма комиссии	450
city_id	Идентификатор города	21989
address	Адрес доставки	Шымкент, ул. Клары Цеткин
town	Город доставки	Шымкент
page_count	Номер страницы	8
total_count	Общее количество записей	113
time	Время выполнения запроса	7.93

Authorizations

apiKeyAuth

AuthorizationstringRequired

Authorization token

Query parameters

page_numberintegerRequired

Текущий номер страницы, начиная с нуля

Example: 1

page_sizeintegerRequired

Количество заказов на одной странице. Максимальное значение равно 1000.

Example: 15

statusstring · enumRequired

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

Example: COMPLETEDPossible values:

created_fromstringRequired

Начальная дата поиска заказа. Указывается в формате unixtimestamp.

Example: 1576139970

created_tostringOptional

Конечная дата поиска заказа. Указывается в формате unixtimestamp.

Example: 1576139970

order_sourcestring · enumOptional

Тип заказа

Example: МаркетплейсPossible values:

Responses

200

OK

application/json

get

/gw/merchant-api-v2/v1/orders

HTTPcURLJavaScriptPython

GET /gw/merchant-api-v2/v1/orders?page_number=1&page_size=1&status=APPROVED_BY_BANK&created_from=text HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "data": [
    {
      "order_id": "1187381",
      "status": "COMPLETED",
      "total_price": "12990.00",
      "user": {
        "phone": "0002284653",
        "firstname": "Имя-2284653",
        "lastname": "Фамилия-2284653"
      },
      "payment_mode": "PAY_WITH_CREDIT",
      "order_source": "QR Tole",
      "installment_term": "6",
      "created_at": "2022-06-18 12:10:15",
      "delivery_mode": "JPOST",
      "delivery_date": "17.11.2023,10:00 - 14:00",
      "delivery": {
        "store_location_info": {
          "company_store_id": "pp1",
          "name": "Power 2",
          "address": "проспект Назарбаева, 100",
          "longitude": "76.946714",
          "latitude": "76.946714",
          "city_id": "21989",
          "city": "Алматы"
        },
        "commission_cpo": "0"
      },
      "products": [
        {
          "product_id": "5674235",
          "master_product_id": "3720147",
          "imageUrl": "https://jmart.kz/images/detailed/4272/lg-lg-178-103722031-1.JPG",
          "product_сode": "103722031",
          "article": "KTJ888800054",
          "product_name": "Блендер стационарный LG LG-178",
          "amount": "1",
          "discount": "0",
          "price": "13890",
          "discountPrice": "13890",
          "gifts": [
            {
              "title": "Иголочка",
              "description": "Иголочка",
              "notes": "иголочка",
              "imageUrl": "https://jmart.kz/images/detailed/6280/image-new-admin-6564145fc21dc8.10588358.png",
              "companies": "[45, 1758]",
              "objects": "[112640]",
              "type": "product",
              "dateStart": "2023-11-20 00:00:00",
              "dateEnd": "2023-11-17 00:00:00",
              "gift_count": "1"
            }
          ]
        }
      ],
      "city_id": "21989",
      "address": "Шымкент, улица Клары Цеткин, 4",
      "town": "Шымкент"
    }
  ],
  "meta": {
    "page_count": "8",
    "total_count": "113"
  },
  "time": "7.93497109413147"
}