4. Получение заказов в различных статусах

На этом этапе вы можете получить список заказов в зависимости от их текущего статуса — новых, в доставке, готовых к выдаче, завершённых или отменённых. Запрос позволяет фильтровать заказы по статусу, номеру, а также по периоду создания.

GET-запрос:

curl --location 'https://halykmarket.kz/gw/merchant/public/order/v2
?size=20&page=1
&orderNumber=1111111111-1
&status=APPROVED_BY_BANK
&startDate=2024-11-28
&endDate=2024-11-29' \
--header 'Authorization: Bearer ваш токен' \

Атрибуты запроса:

Наименование	Описание
page	Номер страницы, начиная с единицы
size	Количество результатов запроса. Максимальное значение — 100
status	1) Статусы нового заказа: • APPROVED_BY_BANK — Новый заказ • ACCEPTED_BY_MERCHANT — Заказ был принят 2) Статусы доставки до двери: • WAITING_COURIER — Ожидание курьера • DELIVERY — В доставке до двери • DELIVERY_COMPLETED — Доставка до двери завершена (промежуточный статус) 3) Статусы доставки в ПВЗ: • WAITING_PVZ_COURIER — Ожидание курьера ПВЗ • DELIVERY_PVZ — В доставке в ПВЗ • READY_FOR_PICKUP_FROM_PVZ — Готов к выдаче из ПВЗ • WAITING_PVZ_COURIER_FOR_RETURN — Заказ ожидает курьера для возврата из ПВЗ • RETURNING_TO_MERCHANT_FROM_PVZ — Возвращается курьером из ПВЗ • RETURNED_TO_MERCHANT_FROM_PVZ — Возвращен курьером из ПВЗ 4) Статусы доставки в постамат: • WAITING_POSTAMAT_COURIER — Ожидание курьера на отправку в Постамат • DELIVERY_POSTAMAT — В доставке в постамат • READY_FOR_PICKUP_FROM_POSTAMAT — Готов к выдаче из постамата • WAITING_POSTAMAT_COURIER_FOR_RETURN — Ожидается возврат из Постамата • RETURNING_TO_MERCHANT_FROM_POSTAMAT — Возвращается курьером из Постамата • RETURNED_TO_MERCHANT_FROM_ POSTAMAT — Возвращен курьером из постамата 5) Общие итоговые статусы: • MERCHANT_COMPLETED — Завершение заказа (промежуточный статус) • COMPLETED — Завершен • CANCEL_REQUESTED — Запрошена отмена (промежуточный статус) • CANCELLED — Отменен • RETURN_REQUESTED — Запрошен возврат (промежуточный статус) • RETURNED / RETURNED_PARTIAL — Возвращен
startDate	Опциональный фильтр. Начало периода фильтрации по дате создания заказа. По умолчанию — заказы за последний месяц
endDate	Опциональный фильтр. Конец периода фильтрации по дате создания заказа. По умолчанию — заказы за последний месяц

Для обращения на тестовый сервер, используйте URL: https://test2-api.halykmarket.com/api/merchant/v1/orders

Ответ сервера (неполный скрин):

Шаблон ответа:

{
    "number": 0,
    "last": false,
    "size": 25,
    "numberOfElements": 25,
    "pageable": {
        "pageNumber": 0,
        "pageSize": 25,
        "sort": {
            "empty": false,
            "sorted": true,
            "unsorted": false
        },
        "offset": 0,
        "unpaged": false,
        "paged": true
    },
    "hasPrevious": false,
    "hasNext": true,
    "content": [
        {
            "type": "orders",
            "id": "11111111",
            "attributes": {
                "code": "0011111111-1",
                "totalPrice": 10000,
                "discountAmount": null,
                "deliveryMode": "PHYSICAL_SHIP",
                "deliveryType": "DELIVERY",
                "deliveryAddress": {
                    "streetName": "Название улицы",
                    "streetNumber": null,
                    "town": "Almaty",
                    "district": null,
                    "building": "1",
                    "formattedAddress": "Almaty, Название улицы, 36"
                },
                "paymentMode": "HALYK_INSTALLMENT",
                "additionalPaymentMode": null,
                "creditPaidAmount": null,
                "cardPaidAmount": null,
                "creditTerm": 6,
                "state": "UNDEFINED",
                "creationDate": 1111111111111,
                "status": "WAITING_COURIER",
                "deliveryCost": 0.00,
                "customer": {
                    "firstName": "ИМЯ",
                    "lastName": "ФАМИЛИЯ",
                    "cellPhone": "77777777777",
                    "iin": "999999999999"
                },
                "providerType": "EXTERNAL",
                "subTotal": 10000.00,
                "addressLetterPath": "накладная.pdf",
                "trackNumber": null,
                "deliveryServiceName": null,
                "trackUrl": null,
                "cancellationReason": null,
                "merchantPassOTP": null,
                "courierName": null,
                "courierPhone": null,
                "discountUsed": false,
                "promocodeUsed": false
            },
            "relationships": {
                "entries": {
                    "links": {
                        "self": "/api.halykmarket.kz/api/merchant/v1/orders/11111111/relationships/entries",
                        "related": "/api.halykmarket.kz/api/merchant/v1/orders/11111111/entries"
                    },
                    "data": [
                        {
                            "type": "orderentries",
                            "id": "11111111"
                        }
                    ]
                }
            },
            "links": {
                "self": "/api.halykmarket.kz/api/merchant/v1/orders/11111111"
            }
        }

Вы получили список заказов в соотв. статусе. Заказы в ответе - не старше 90 дней по дате создания от текущей даты.