Page tree
Skip to end of metadata
Go to start of metadata

Общая информация

API для продавцов Kaspi Магазина – программный интерфейс, который предназначен для получения информации о заказах и сопутствующих данных, поступивших через платформу Kaspi Магазина. Данный программный интерфейс соответствует спецификации JSON API. Спецификация описывает процесс взаимодействия клиент серверных систем, построенных на базе формата сообщений JSON и протокола передачи гипертекста (HTTP).

Каждый запрос в систему сопровождается заголовками и набором параметров.
Обязательными заголовками являются следующие:
• Content-Type – тип тела запроса, соответствующий стандарту MIME. Данный заголовок должен соответствовать зарегистрированному значению application/vnd.api+json
• X-Auth-Token – токен авторизации. Уникальный идентификатор, позволяющий получить доступ к программному интерфейсу. Сгенерировать токен авторизации можно самостоятельно через личный кабинет. Подробнее по ссылке. На данный момент, однажды полученный идентификатор не меняется с течением времени, однако процесс инвалидации может поменяться.

Набор параметров, передаваемых с запросом, может отличаться. Параметры бывают двух типов: обязательные и необязательные. Помимо этого, параметры отличаются по способу модификации извлекаемых данных:
• Сортировка – описывается с помощью ключевого слова sort и поля, по которому выполняется сортировка. Например: sort=age, что указывает на то, что сортировка будет выполнена по полю age, в восходящем порядке.
• Построчный вывод – описывается с помощью ключевого слова page и дополнительного параметра. Например: page[number]=1 и page[size]=20, будут указывать на извлечение первой страницы результатов, где каждая страница содержит 20 значений.
• Фильтрация – указывается с помощью ключевого слова filter, сущности и поля подвергающихся фильтрации. Например: filter[orders][status]=COMPLETED означает, что будут выбраны все значения сущности orders, у которых поле статуса будет соответствовать значению COMPLETED. Помимо этого, фильтры поддерживают опциональные операторы:
◦ $lt– (lower than) извлекает значения, которые меньше, чем указанное в фильтре;
◦ $gt– (greater than) извлекает значения, которые больше, чем указанное в фильтре;
◦ $le– (lower or equal to) извлекает значения, которые меньше, или равны указанному в фильтре;
◦ $ge– (greater or equal to) извлекает значения, которые больше, или равны указанному в фильтре.
Пример использования фильтра с оператором: filter[orders][creationDate][$ge]=1478736000000 и filter[orders][creationDate][$le]=1479945600000 означает, что дата создания заказа будет больше, или равна 10 ноября 2016 года, либо меньше или равна 24 ноября 2016 года. Значения фильтра указываются в миллисекундах по Timestamp.
Все даты указываются в часовом поясе Алматы.
Важно учесть, что набор параметров, передаваемый с каждым запросом, может отличаться, и сервис не гарантирует поддержку сортировки, фильтрации и постраничного вывода в случаях, не описанных в данной документации.

Ответ на запрос может содержать следующие объекты:
• data – массив сущностей, удовлетворяющих параметрам запроса.
В свою очередь, каждая из сущностей, содержит следующие подобъекты:
◦ type – строковое обозначение извлечённой сущности.
◦ id – строковый идентификатор сущности.
◦ attributes – объект, со всеми атрибутами сущности.
◦ relationships – объект, со всеми отношениями сущности. Отношения могут указывать либо на множество объектов, входящих в состав текущей сущности, либо на один объект.
◦ links – дополнительные ссылки.
• included – включённые в запрос подсущности. Выбранную подсущность можно указать с помощью параметра include. Например: include[orders]=user, говорит о том, что сущность user, входящая в состав сущности orders, будет включена в результаты выполнения запроса.
• meta – мета информация. Например, количество страниц в запросе, или общее количество результатов.

Варианты запросов

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

Описание
Данный запрос возвращает список заказов, оставленных покупателями. Содержит общую цену заказа, типы доставки и оплаты, статус, состояние, даты создания и одобрения банком.

 Запрос
GET
https://kaspi.kz/shop/api/v2/orders?page[number]=0&page[size]=20&filter[orders][state]=NEW
&filter[orders][creationDate][$ge]=1478736000000&filter[orders][creationDate][$le]=1479945600000
&filter[orders][status]=APPROVED_BY_BANK&filter[orders][deliveryType]=PICKUP
&filter[orders][signatureRequired]=false&include[orders]=user
Content-Type:application/vnd.api+json
X-Auth-Token: <token>
 Ответ


{
"data": [
{
"type": "orders",
"id": "MjAwMTMwMDQ=",
"attributes": {
"customer": {
"firstName": "Иван Иваныч",
"lastName": "Иванов",
"cellPhone": "7xx0xxxxxx"
},
"code": "20013004",
"totalPrice": 96045,
"deliveryMode":
"DELIVERY_PICKUP",
"paymentMode": "PAY_WITH_CREDIT",
"signatureRequired": false,
"state": "PICKUP",
"creationDate": 1479470446241,
"approvedByBankDate":1479470451108,
"status": "ACCEPTED_BY_MERCHANT",
"deliveryCost": 1000
},
"relationships": {
"entries": {
"links": {
"self": "/v2/orders/MjAwMTMwMDQ=/relationships/entries",
"related": "/v2/orders/MjAwMTMwMDQ=/entries"
}
},
"user": {
"links": {
"self": "/v2/orders/MjAwMTMwMDQ=/relationships/user",
"related": "/v2/orders/MjAwMTMwMDQ=/user"
},
"data": {
"type": "customers",
"id": "Nzc3MDAwMDAwMA=="
}
}
},
"links": {
"self": "/v2/orders/MjAwMTMwMDQ="
}
}
],
"included": [
{
"type": "customers",
"id":"Nzc3MDAwMDAwMA==",
"attributes": {
"firstName": "Иван",
"lastName": "Иваныч",
"cellPhone": "7xx0xxxxxx"
},
"relationships": {},
"links": {
"self":"/v2/customers/Nzc3MDAwMDAwMA=="
}
}
],
"meta": {
"pageCount": 1,
"totalCount": 1
}
}

Параметры
page[number]
Номер страницы, начиная с нуля. Обязательный параметр
page[size]
Количество результатов запроса. Максимальное значение равно 1000. !Обязательный параметр.
filter[orders][state]
Состояние заказа. Обязательный параметр
Перечисляемый тип, может иметь одно из следующих значений:
· NEW – новый заказ
· SIGN_REQUIRED– заказ на подписании
· PICKUP – самовывоз
· DELIVERY – доставка
· KASPI_DELIVERY – Kaspi Доставка
· ARCHIVE – архивный заказ

filter[orders][status]
Статусы заказа. Перечисляемый тип, может принимать следующие значения:
· APPROVED_BY_BANK– одобрен банком
· ACCEPTED_BY_MERCHANT– принят на обработку продавцом
· COMPLETED – завершён
· CANCELLED – отменён
· CANCELLING – ожидает отмены
· KASPI_DELIVERY_RETURN_REQUESTED – ожидает возврата
· RETURN_ACCEPTED_BY_MERCHANT – ожидает решения по возврату
· RETURNED – возвращён

filter[orders][creationDate][$ge]
Начальная дата поиска заказа. Указывается в миллисекундах. Обязательный параметр
filter[orders][creationDate][$le]
Конечная дата поиска заказа. Указывается в миллисекундах. По умолчанию равна текущей дате. Максимальный период поиска – 14 дней.
filter[orders][deliveryType]

[creationDate] - данный атрибут возвращает ответ в зависимости от [orders][state], то есть  выдаст ответ по дате присвоения  выбранного  [orders][state].


Способ доставки заказа. Перечисляемый тип, может принимать одно из следующих значений:
·PICKUP- самовывоз
·DELIVERY- доставка
Важно: данный фильтр может использоваться, если фильтр по state не равен к данному способу доставки.
filter[orders][signatureRequired]
Требуется ли подписания документов.
Булевое значение:
· true – подписания требуется
· false – подписания не требуется
Важно: данный фильтр может использоваться, если фильтр по state не равен SIGN_REQUIRED.

Атрибуты
code – код заказа
totalPrice – общая сумма заказа в тенге
customer – клиент, совершивший заказ. Содержит в себе имя, фамилию и номер телефона
deliveryMode – способ осуществляемой доставки. Может принимать следующие значения:
· DELIVERY_LOCAL – доставка в пределах населённого пункта
· DELIVERY_PICKUP – самовывоз
· DELIVERY_REGIONAL_PICKUP – региональная доставка до точки самовывоза
· DELIVERY_REGIONAL_TODOOR – региональная доставка до дверей

paymentMode – способ оплаты заказа. Может принимать следующие значения:
· PAY_WITH_CREDIT – покупка в кредит
· PREPAID – безналичная оплата

signatureRequired – булевое значение, указывает на необходимость подписания кредита
isKaspiDelivery - булевое значение, указывает является ли заказ по Kaspi Доставке или нет
creditTerm – срок кредита/рассрочки
preOrder – булевое значение, является ли заказ предзаказом или нет
state – состояние заказа. Перечисляемый тип. Может принимать те же значения, что и соответствующий параметр запроса
creationDate – дата создания заказа в миллисекундах.
approvedByBankDate – дата одобрения заказа банком в миллисекундах
plannedDeliveryDate – дата доставки в миллисекундах
reservationDate – дата доставки в миллисекундах 
status – статус заказа. Перечисляемый тип. Может принимать те же значения, что и соответствующий параметр запроса
deliveryCost – стоимость доставки (double)
waybill – ссылка на печатную накладную для заказов Kaspi Доставки
courierTransmissionPlanningDate - планируемая дата передачи заказа курьеру в миллисекундах (Kaspi Доставка)
courierTransmissionDate – дата передачи заказа курьеру в миллисекундах (Kaspi Доставка)
latitude – географический координат (широта)
longitude – географический координат (долгота)
waybillNumber – номер накладной курьерской службы
category – категория товара
deliveryCostForSeller – комиссия за доставку
apartment – квартира

Взаимосвязи
entries – состав заказа
user – пользователь системы, оставивший заказ

Ссылки
self – ссылка, указывающая на сам заказ. По ней можно будет получить данный конкретный заказ.

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

Описание
Данный запрос возвращает состав заказа оставленных покупателями. Содержит общую цену заказа, типы доставки и оплаты, статус, состояние, даты создания и одобрения банком.
Параметры
filter[orders][code]
Код заказа. Обязательный параметр пути
Взаимосвязи
deliveryPointOfService – точка продажи
product – продаваемый продукт
Ссылки
self – ссылка, по котором можно получить конкретный подпункт заказа.

 Запрос
GET
https://kaspi.kz/shop/api/v2/orders?filter[orders][code]=20013004
ContentType: application/vnd.api+json
X-Auth-Token:token
 Ответ


{
"data": [
{
"type": "orders",
"id": "MTI0JjQwMDE2",
"attributes": {
"code": "20013004",
"totalPrice": 29900,
"paymentMode": "PREPAID",
“plannedDeliveryDate": 1515600621566
"creationDate": 1568800627621,
"isKaspiDelivery": true,
"deliveryMode": "DELIVERY_REGIONAL_TODOOR",
"deliveryAddress": {
"streetName": "Улица",
"streetNumber": "22/4",
"town": "Нур-Султан",
"district": null,
"building": null,
"formattedAddress": "Нур-Султан, Улица, 22/4, 4",
"latitude": 43.240007,
"longitude": 76.938818
},
"signatureRequired": false,
"creditTerm": 0,
"kaspiDelivery": {
"waybill": "20013004-EXLINE.pdf",
"courierTransmissionDate": 1568833225597,
"courierTransmissionPlanningDate": 1568831200000
},
"preOrder": false,
"state": "ARCHIVE",
"approvedByBankDate": 1568800634220,
"status": "COMPLETED",
"customer": {
"id": "NzAyOTY0ODEwMQ==",
"name": "Иван",
"cellPhone": "7020000000",
"firstName": "Иван",
"lastName": "Иванов"
},
"deliveryCost": 0
},
"relationships": {
"entries": {
"links": {
"self": "/v2/orders/MTI0JjQwMDE2/relationships/entries",
"related": "/v2/orders/MTI0JjQwMDE2/entries"
}
},
"user": {
"links": {
"self": "/v2/orders/MTI0JjQwMDE2/relationships/user",
"related": "/v2/orders/MTI0JjQwMDE2/user"
},
"data": {
"type": "customers",
"id": "NzAyOTY0ODEw79=="
}
}
},
"links": {
"self": "/v2/orders/MTI0JjQwMDE2"
}
}
],
"included": [],
"meta": {
"pageCount": 1,
"totalCount": 1
}
}

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

Описание
Данный запрос возвращает состав заказа оставленных покупателями. Содержит общую цену заказа, цену за каждый товар, количество товара - по всем товарам которые есть в заказе.

В заказе могут быть несколько разных товаров, в нескольких количествах. В таких случаях, нужно запросить информацию по каждому подпункту отдельно.

Параметры
orderId
Идентификатор заказа. Обязательный параметр пути

Атрибуты
quantity– количество штук товара

entryNumber – порядковый номер подпункта заказа
totalPrice – общая цена по продукту в подпункте заказа
deliveryCost – стоимость доставки (double)
basePrice – цена продукта в подпункте заказа

Взаимосвязи
deliveryPointOfService – точка продажи
product – продаваемый продукт

Ссылки
self – ссылка, по которому можно получить конкретный подпункт заказа.

 Запрос
GET
https://kaspi.kz/shop/api/v2/orders/MjAwMTMwMDM=/entries
ContentType: application/vnd.api+json
X-Auth-Token:token
 Ответ
{
    "data": [
        {
            "type": "orderentries",
            "id": "MTQwMjYzNjcwIyMw",
            "attributes": {
                "quantity": 1,
                "totalPrice": 1390.0,
                "entryNumber": 0,
                "deliveryCost": 0.0,
                "basePrice": 1390.0
            },
            "relationships": {
                "product": {
                    "links": {
                        "self": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwIyMw/relationships/product",
                        "related": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwIyMw/product"
                    },
                    "data": {
                        "type": "masterproducts",
                        "id": "MjYwMDExMTQ="
                    }
                },
                "deliveryPointOfService": {
                    "links": {
                        "self": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwIyMw/relationships/deliveryPointOfService",
                        "related": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwIyMw/deliveryPointOfService"
                    },
                    "data": {
                        "type": "pointofservices",
                        "id": "TUhvbWVWaWRlb19BQVIxODY="
                    }
                }
            },
            "links": {
                "self": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwIyMw"
            }
        },
        {
            "type": "orderentries",
            "id": "MTQwMjYzNjcwIyMx",
            "attributes": {
                "quantity": 2,
                "totalPrice": 2690.0,
                "entryNumber": 1,
                "deliveryCost": 0.0,
                "basePrice": 1345.0
            },
            "relationships": {
                "product": {
                    "links": {
                        "self": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwIyMx/relationships/product",
                        "related": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwIyMx/product"
                    },
                    "data": {
                        "type": "masterproducts",
                        "id": "MTAwMDIwNzM4"
                    }
                },
                "deliveryPointOfService": {
                    "links": {
                        "self": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwIyMx/relationships/deliveryPointOfService",
                        "related": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwIyMx/deliveryPointOfService"
                    },
                    "data": {
                        "type": "pointofservices",
                        "id": "TUhvbWVWaWRlb19XTVI="
                    }
                }
            },
            "links": {
                "self": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwIyMx"
            }
        }
    ],
    "included": []
}


Получение подпункта заказа

Описание
Данный запрос возвращает подпункт заказа. Содержит цену за каждый товар, количество товара - по каждому товару в заказе.

В заказе могут быть несколько разных товаров, в нескольких количествах. В таких случаях, нужно запросить информацию по каждому подпункту отдельно.


Параметры
entryId
Идентификатор подпункта заказа. Обязательный параметр пути
Атрибуты
quantity– количество штук товара
entryNumber – порядковый номер подпункта заказа
totalPrice – общая цена по продукту в подпункте заказа
deliveryCost – стоимость доставки (double)
basePrice – цена продукта в подпункте заказа

Взаимосвязи
deliveryPointOfService – точка продажи
product – продаваемый продукт
Ссылки
self – ссылка, по которому можно получить конкретный подпункт заказа.

 Запрос
GET
https://kaspi.kz/shop/api/v2/orderentries/MjAwMTMwMDMjIzA=
ContentType: application/vnd.api+json
X-Auth-Token:token
 Ответ
{
    "data": {
        "type": "orderentries",
        "id": "MTQwMjYzNjcwI",
        "attributes": {
            "quantity": 1,
            "totalPrice": 1390.0,
            "entryNumber": 0,
            "deliveryCost": 0.0,
            "basePrice": 1390.0
        },
        "relationships": {
            "product": {
                "links": {
                    "self": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwI/relationships/product",
                    "related": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwI/product"
                },
                "data": {
                    "type": "masterproducts",
                    "id": "MjYwMDExMT="
                }
            },
            "deliveryPointOfService": {
                "links": {
                    "self": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwI/relationships/deliveryPointOfService",
                    "related": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwI/deliveryPointOfService"
                },
                "data": {
                    "type": "pointofservices",
                    "id": "TUhvbWVWaWRlb19BQVIOD="
                }
            }
        },
        "links": {
            "self": "https://kaspi.kz/shop/api/v2/orderentries/MTQwMjYzNjcwI"
        }
    },
    "included": []
}


Получение пользователя, совершившего заказ (Deprecated)

Описание
Данный запрос возвращает объект, с информацией о пользователе, совершившем заказ. Содержит имя клиента и его номер телефона.
Deprecated: Вместо этого запроса следует использовать информацию о пользователе, полученную в запросе со списком заказов.
Параметры
orderId
Идентификатор заказа. Обязательный параметр пути
Атрибуты
name – имя пользователя, может отличаться от имени, указанного при оформлении заказа
lastName — фамилия пользователя
cellPhone – телефонный номер
Ссылки
self – ссылка, указывающая на этого клиента. По ней можно получить данного пользователя системы.

 Запрос
GET
https://kaspi.kz/shop/api/v2/orderentries/MjAwMTMwMDMjIzA=/deliveryPointOfService
Content-Type: application/vnd.api+json
X-Auth-Token: token
 Ответ
{
"data": {
"type": "pointofservices",
"id": "QUxNQVNIT1BfUFAx",
"attributes": {
"address": {
"streetName": "ТРК Рамстор Галерея ул. Тимирязева",
"streetNumber": "цокольный этаж",
"town": "г. Алматы",
"district": null,
"building": null,
"formattedAddress": "г. Алматы, ТРК Рамстор Галерея ул. Тимирязева, цокольный этаж"
},
"displayName": "PP1"
},
"relationships":
{ "city": {
"links": {
"self": "/v2/pointofservices/QUxNQVNIT1BfUFAx/relationships/city",
"related": "/v2/pointofservices/QUxNQVNIT1BfUFAx/city"
},
"data": {
"type": "cities",
"id": "NzUwMDAwMDAw"
}
}
},
"links": {
"self": "/v2/pointofservices/QUxNQVNIT1BfUFAx"
}
},
"included": []
}

Получение точки продаж из подпункта заказа

Описание
Данный запрос возвращает точку продажи конкретного подпункта заказа. Содержит отображаемое имя и адрес точки продаж.
Параметры
orderEntryId
Идентификатор подпункта заказа. Обязательный параметр пути
Атрибуты
address– адрес точки продаж, содержит следующие поля:
· streetName – улица
· streetNumber – номер
· town – город
· district – район
· building – здание
· formattedAddress – полноформатный адрес
displayName – отображаемое имя
Взаимосвязи
city – город, в котором находится точка продаж
Ссылки
self – ссылка, указывающая на саму точку продаж. По ней можно получить данную конкретную точку.

 Запрос
GET
https://kaspi.kz/shop/api/v2/orderentries/MjAwMTMwMDMjIzA=/deliveryPointOfService
Content-Type: application/vnd.api+json
X-Auth-Token: token
 Ответ
{
"data": {
"type": "pointofservices",
"id": "QUxNQVNIT1BfUFAx",
"attributes": {
"address": {
"streetName": "ТРК Рамстор Галерея ул. Тимирязева",
"streetNumber": "цокольный этаж",
"town": "г. Алматы",
"district": null,
"building": null,
"formattedAddress": "г. Алматы, ТРК Рамстор Галерея ул. Тимирязева, цокольный этаж"
},
"displayName": "PP1"
},
"relationships": {
"city": {
"links": {
"self": "/v2/pointofservices/QUxNQVNIT1BfUFAx/relationships/city",
"related": "/v2/pointofservices/QUxNQVNIT1BfUFAx/city"
},
"data": {
"type": "cities",
"id": "NzUwMDAwMDAw"
}
}
},
"links": {
"self": "/v2/pointofservices/QUxNQVNIT1BfUFAx"
}
},
"included": []
}

Получение точки продаж

Описание
Данный запрос возвращает точку продажи по идентификатору. Содержит отображаемое имя и адрес точки продаж.
Параметры
pointOfServiceId
Идентификатор подпункта заказа. Обязательный параметр пути
Атрибуты
address – адрес точки продаж, содержит следующие поля:
· streetName – улица
· streetNumber – номер
· town – город
· district – район
· building – здание
· formattedAddress –полноформатный адрес
displayName – отображаемое имя
Взаимосвязи
city – город, в котором находится точка продаж
Ссылки
self – ссылка, указывающая на саму точку продаж.

 Запрос
GET
https://kaspi.kz/shop/api/v2/pointofservices/QUxNQVNIT1BfUFAx
Content-Type: application/vnd.api+json
X-Auth-Token: token
 Ответ
{
"data": {
"type": "pointofservices",
"id": "QUxNQVNIT1BfUFAx",
"attributes": {
"address": {
"streetName": "ТРК Рамстор Галерея ул. Тимирязева",
"streetNumber": "цокольный этаж",
"town": "г. Алматы",
"district": null,
"building": null,
"formattedAddress": "г. Алматы, ТРК Рамстор Галерея ул. Тимирязева, цокольный этаж"
},
"displayName": "PP1"
},
"relationships": {
"city": {
"links": {
"self": "/v2/pointofservices/QUxNQVNIT1BfUFAx/relationships/city",
"related": "/v2/pointofservices/QUxNQVNIT1BfUFAx/city"
},
"data": {
"type": "cities",
"id": "NzUwMDAwMDAw"
}
}
},
"links": {
"self": "/v2/pointofservices/QUxNQVNIT1BfUFAx"
}
}
}

Получение продукта из подпункта заказа

Описание
Данный запрос возвращает продукт конкретного подпункта заказа. Содержит код, наименование и производителя товара.
Параметры
orderEntryId
Идентификатор подпункта заказа. Обязательный параметр пути
Атрибуты
code – код товара
name – наименование товара
manufacturer – производитель товара
Ссылки
self – ссылка, указывающая на сам продукт. По ней можно получить данный конкретный товар.

 Запрос
GET
https://kaspi.kz/shop/api/v2/orderentries/MjAwMTMwMDMjIzA=/product
Content-Type: application/vnd.api+json
X-Auth-Token: token
 Ответ
{
"data": {
"type": "masterproducts",
"id": "MTAwMDEwMA==",
"attributes": {
"code": "1000100",
"name": "LG Optimus L5 II Dual E455 White",
"manufacturer": "LG"
},
"relationships": {
"merchantProduct": {
"links": {
"self": "/v2/masterproducts/MTAwMDEwMA==/relationships/merchantProduct",
"related": "/v2/masterproducts/MTAwMDEwMA==/merchantProduct"
},
"data": {
"type": "merchantproducts",
"id": "THVjaGVudGUjIzI1MDQ3NDMt0JA1MC0wMQ=="
}
}
},
"links": {
"self": "/v2/masterproducts/MTAwMDEwMA=="
}
},
 "included": []
}

Получение продукта продавца из подпункта заказа

Описание
Данный запрос возвращает продукт продавца конкретного подпункта заказа. Содержит код, наименование и производителя товара.
Параметры
orderEntryId
Идентификатор подпункта заказа. Обязательный параметр пути
Атрибуты
code – код товара из прайс-листа продавца(SKU)
name – наименование товара
manufacturer – производитель товара
Ссылки
self – ссылка, указывающая на сам продукт. По ней можно получить данный конкретный товар.

 Запрос
GET
https://kaspi.kz/shop/api/v2/masterproducts/MTAwMDEwMA==/relationships/merchantProduct
Content-Type: application/vnd.api+json
X-Auth-Token: token
 Ответ


{
    "data": {
        "type": "merchantproducts",
        "id": "TUhvbWVWaWRlbyMjNjkyMjEy",
        "attributes": {
            "code": "692212",
            "name": "Optimus L5 II Dual E455",
            "manufacturer": "LG"
        },
        "relationships": {},
        "links": {
            "self": "https://kaspi.kz/shop/api/v2/merchantproducts/TUhvbWVWaWRlbyMjNjkyMjEy"
        }
    },
    "included": []
}



Получение продукта

Описание
Данный запрос возвращает продукт по идентификатору. Содержит код, наименование и производителя товара.
Параметры
productId
Идентификатор подпункта заказа. Обязательный параметр пути
Атрибуты
code – код товара
name – наименование товара
manufacturer – производитель товара
Ссылки
self – ссылка, указывающая на сам продукт. По ней можно получить данный конкретный товар.

 Запрос
GET
https://kaspi.kz/shop/api/v2/orderentries/MjAwMTMwMDMjIzA=/product
Content-Type: application/vnd.api+json
X-Auth-Token: token
 Ответ
{
"data": {
"type": "masterproducts",
"id": "MTAwMDEwMA==",
"attributes": {
"code": "1000100",
"name": "LG Optimus L5 II Dual E455 White",
"manufacturer": "LG"
},
"relationships": {
"merchantProduct": {
"links": {
"self": "/v2/masterproducts/MTAwMDEwMA==/relationships/merchantProduct",
"related": "/v2/masterproducts/MTAwMDEwMA==/merchantProduct"
},
"data": {
"type": "merchantproducts",
"id": "THVjaGVudGUjIzI1MDQ3NDMt0JA1MC0wMQ=="
}
}
},
"links": {
"self": "/v2/masterproducts/MTAwMDEwMA=="
}
},
 "included": []
}


Получение города из точки продаж

Описание
Данный запрос возвращает город конкретной точки продаж. Содержит код, название и статус активности.
Параметры
pointOfServiceId
Идентификатор точки продаж. Обязательный параметр пути
Атрибуты
code – код города
name – название города
active – статус активности
Ссылки
self – ссылка, указывающая на сам город. По ней можно получить данный конкретный город.

 Запрос
GET
https://kaspi.kz/shop/api/v2/pointofservices/QUxNQVNIT1BfUFAx/city
Content-Type: application/vnd.api+json
X-Auth-Token: token
 Ответ
{
"data": {
"type": "cities",
"id": "NzUwMDAwMDAw",
"attributes": {
"code": "750000000",
"name": "Алматы",
"active": true
},
"relationships": {},
"links": {
"self": "/v2/cities/NzUwMDAwMDAw"
}
},
"included": []
}

Получение списка городов

Описание
Данный запрос возвращает список городов. Содержит код, название и статус активности.
Атрибуты
code – код города
name – название города
active – статус активности
Ссылки
self – ссылка, указывающая на сам город. По ней можно получить данный конкретный город.

 Запрос
GET
https://kaspi.kz/shop/api/v2/cities
Content-Type: application/vnd.api+json
X-Auth-Token: token
 Ответ

{
"data": [
{
"type": "cities",
"id": "NDcxMDEwMDAw",
"attributes": {
"code": "471010000",
"name": "Актау",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NDcxMDEwMDAw"
}
},
{
"type": "cities",
"id": "MTUxMDEwMDAw",
"attributes": {
"code": "151010000",
"name": "Актобе",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MTUxMDEwMDAw"
}
},
{
"type": "cities",
"id": "NzUwMDAwMDAw",
"attributes": {
"code": "750000000",
"name": "Алматы",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NzUwMDAwMDAw"
}
},
{
"type": "cities",
"id": "NzEwMDAwMDAw",
"attributes": {
"code": "710000000",
"name": "Нур-Султан",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NzEwMDAwMDAw"
}
},
{
"type": "cities",
"id": "MjMxMDEwMDAw",
"attributes": {
"code": "231010000",
"name": "Атырау",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MjMxMDEwMDAw"
}
},
{
"type": "cities",
"id": "MzUxODEwMDAw",
"attributes": {
"code": "351810000",
"name": "Жезказган",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MzUxODEwMDAw"
}
},
{
"type": "cities",
"id": "MzUxMDEwMDAw",
"attributes": {
"code": "351010000",
"name": "Караганда",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MzUxMDEwMDAw"
}
},
{
"type": "cities",
"id": "MTk1MjIwMTAw",
"attributes": {
"code": "195220100",
"name": "Каскелен",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MTk1MjIwMTAw"
}
},
{
"type": "cities",
"id": "MTExMDEwMDAw",
"attributes": {
"code": "111010000",
"name": "Кокшетау",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MTExMDEwMDAw"
}
},
{
"type": "cities",
"id": "MzE0ODUxMjA1",
"attributes": {
"code": "314851205",
"name": "Кордай",
"active": false
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MzE0ODUxMjA1"
}
},
{
"type": "cities",
"id": "MzkxMDEwMDAw",
"attributes": {
"code": "391010000",
"name": "Костанай",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MzkxMDEwMDAw"
}
},
{
"type": "cities",
"id": "MjMzNjIwMTAw",
"attributes": {
"code": "233620100",
"name": "Кульсары",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MjMzNjIwMTAw"
}
},
{
"type": "cities",
"id": "NDMxMDEwMDAw",
"attributes": {
"code": "431010000",
"name": "Кызылорда",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NDMxMDEwMDAw"
}
},
{
"type": "cities",
"id": "NTUxMDEwMDAw",
"attributes": {
"code": "551010000",
"name": "Павлодар",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NTUxMDEwMDAw"
}
},
{
"type": "cities",
"id": "NTkxMDEwMDAw",
"attributes": {
"code": "591010000",
"name": "Петропавловск",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NTkxMDEwMDAw"
}
},
{
"type": "cities",
"id": "MzkyNDEwMDAw",
"attributes": {
"code": "392410000",
"name": "Рудный",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MzkyNDEwMDAw"
}
},
{
"type": "cities",
"id": "MzUyMzEwMDAw",
"attributes": {
"code": "352310000",
"name": "Сатпаев",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MzUyMzEwMDAw"
}
},
{
"type": "cities",
"id": "NjMyODEwMDAw",
"attributes": {
"code": "632810000",
"name": "Семей",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NjMyODEwMDAw"
}
},
{
"type": "cities",
"id": "MTk2MjIwMTAw",
"attributes": {
"code": "196220100",
"name": "Талгар",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MTk2MjIwMTAw"
}
},
{
"type": "cities",
"id": "MTkxMDEwMDAw",
"attributes": {
"code": "191010000",
"name": "Талдыкорган",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MTkxMDEwMDAw"
}
},
{
"type": "cities",
"id": "MzExMDEwMDAw",
"attributes": {
"code": "311010000",
"name": "Тараз",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MzExMDEwMDAw"
}
},
{
"type": "cities",
"id": "MzUyNDEwMDAw",
"attributes": {
"code": "352410000",
"name": "Темиртау",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MzUyNDEwMDAw"
}
},
{
"type": "cities",
"id": "MjcxMDEwMDAw",
"attributes": {
"code": "271010000",
"name": "Уральск",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MjcxMDEwMDAw"
}
},
{
"type": "cities",
"id": "NjMxMDEwMDAw",
"attributes": {
"code": "631010000",
"name": "Усть-Каменогорск",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NjMxMDEwMDAw"
}
},
{
"type": "cities",
"id": "NTExMDEwMDAw",
"attributes": {
"code": "511010000",
"name": "Шымкент",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NTExMDEwMDAw"
}
},
{
"type": "cities",
"id": "NTUyMjEwMDAw",
"attributes": {
"code": "552210000",
"name": "Экибастуз",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NTUyMjEwMDAw"
}
},
{
"type": "cities",
"id": "MjczNjIwMTAw",
"attributes": {
"code": "273620100",
"name": "Аксай",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MjczNjIwMTAw"
}
},
{
"type": "cities",
"id": "NTE1NDIwMTAw",
"attributes": {
"code": "515420100",
"name": "Сарыагаш",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NTE1NDIwMTAw"
}
},
{
"type": "cities",
"id": "MTE3MDU1OTAw",
"attributes": {
"code": "117055900",
"name": "Шиели",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MTE3MDU1OTAw"
}
},
{
"type": "cities",
"id": "MzUyODEwMDAw",
"attributes": {
"code": "352810000",
"name": "Шахтинск",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MzUyODEwMDAw"
}
},
{
"type": "cities",
"id": "MTkxNjEwMDAw",
"attributes": {
"code": "191610000",
"name": "Капшагай",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MTkxNjEwMDAw"
}
},
{
"type": "cities",
"id": "NTEyNjEwMDAw",
"attributes": {
"code": "512610000",
"name": "Туркестан",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NTEyNjEwMDAw"
}
},
{
"type": "cities",
"id": "NjM0ODIwMTAw",
"attributes": {
"code": "634820100",
"name": "Алтай",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NjM0ODIwMTAw"
}
},
{
"type": "cities",
"id": "NTExNjEwMDAw",
"attributes": {
"code": "511610000",
"name": "Арысь",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NTExNjEwMDAw"
}
},
{
"type": "cities",
"id": "MTU2NDIwMTAw",
"attributes": {
"code": "156420100",
"name": "Риддер",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MTU2NDIwMTAw"
}
},
{
"type": "cities",
"id": "MzUyMjEwMDAw",
"attributes": {
"code": "352210000",
"name": "Сарань",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MzUyMjEwMDAw"
}
},
{
"type": "cities",
"id": "NTE0NDIwMTAw",
"attributes": {
"code": "514420100",
"name": "Жетысай",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NTE0NDIwMTAw"
}
},
{
"type": "cities",
"id": "MDAwMDAwMDAx",
"attributes": {
"code": "000000001",
"name": "Москва",
"active": false
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MDAwMDAwMDAx"
}
},
{
"type": "cities",
"id": "MTk0MDIwMTAw",
"attributes": {
"code": "194020100",
"name": "Есик",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MTk0MDIwMTAw"
}
},
{
"type": "cities",
"id": "NDcxODEwMDAw",
"attributes": {
"code": "471810000",
"name": "Жанаозен",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/NDcxODEwMDAw"
}
},
{
"type": "cities",
"id": "MzUxNjEwMDAw",
"attributes": {
"code": "351610000",
"name": "Балхаш",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MzUxNjEwMDAw"
}
},
{
"type": "cities",
"id": "MTE3MDIwMTAw",
"attributes": {
"code": "117020100",
"name": "Щучинск",
"active": true
},
"relationships": {},
"links": {
"self": "https://kaspi.kz/shop/api/v2/cities/MTE3MDIwMTAw"
}
}
],
"included": []
}

Изменение статуса заказа

Описание
Данный запрос изменяет статус заказа
Параметры
type – Тип объекта. orders Обязательный параметр
id – Идентификатор объекта Обязательный параметр

Атрибуты
code – Код заказа. Необязательный атрибут
status – Новый статус заказа. Обязательный атрибут. Может принимать одно из следующих значений:
• ACCEPTED_BY_MERCHANT — Товар принят продавцом. Может быть использован, только если текущий статус APPROVED_BY_BANK
• COMPLETED – Товар выдан покупателю. Может быть использован, только если текущий статус ACCEPTED_BY_MERCHANT
• CANCELLED – Заказ отменен. Может быть использован, только если текущий статус ACCEPTED_BY_MERCHANT или APPROVED_BY_BANK
• ARRIVED – Товар прибыл в региональную точку продаж. Может быть использован, только для заказов с региональной доставкой/предзаказом и если текущий статус ACCEPTED_BY_MERCHANT
• ARRIVED_BACKWARD – Товар прибыл в магазин по ранее отмененному заказу или по оформленному возврату товара до магазина. Может быть использован, только для заказов с Kaspi Доставкой и если текущий статус CANCELLING или KASPI_DELIVERY_RETURN_REQUESTED
• ASSEMBLE – Заказ скомплектован. Может быть использован, только если текущий статус ACCEPTED_BY_MERCHANT и если заказ ожидает передачи курьеру
cancellationReason – Причина отмены. Необходим только при статусе заказа CANCELLED. Может принимать одно из следующих значений:
• BUYER_CANCELLATION_BY_MERCHANT – Отказ покупателя
• BUYER_NOT_REACHABLE – Не удалось дозвониться до покупателя
• MERCHANT_OUT_OF_STOCK – Нет в наличии
cancellationComment – Комментарий при отмене заказа. Может быть выставлен только при статусе заказа CANCELLED. Не должен быть больше 1000-ти знаков.
Ответ
В ответ на запрос должен вернуться объект с успешно обновлённым статусом

Подтверждение заказа

Описание
Данный запрос изменяет статус заказа на Принят
Параметры
type – Тип объекта. orders Обязательный параметр
id – Идентификатор объекта Обязательный параметр
Атрибуты
code – Код заказа. Необязательный атрибут
status - Обязательный атрибут
ACCEPTED_BY_MERCHANT — Товар принят продавцом. Может быть использован, только если текущий статус APPROVED_BY_BANK

 Запрос
https://kaspi.kz/shop/api/v2/orders
POST /api/v2/orders
HTTP/1.1
Host: kaspi.kz/shop
Content-Type: application/vnd.api+json
X-Auth-Token:token
{ 
"data":
{
"type": "orders",
"id": "MjAwNTcwMDM=",
"attributes": {
"code": "20049002",
"status": "ACCEPTED_BY_MERCHANT"
}
}
 Ответ
{
"data": {
"type": "orders",
"id": "MjAwNTcwMDM=",
"attributes": {
"code": "20049002",
"status": "ACCEPTED_BY_MERCHANT"
},
"relationships": {
"entries": {
"links": {
"self": "/v2/orders/MjAwNTcwMDM=/relationships/entries",
"related": "/v2/orders/MjAwNTcwMDM=/entries"
}
}
}
}
},

Комплектация заказа (Kaspi Доставка)

Описание
Данный запрос изменяет статус заказа на Скомплектован
Параметры
type – Тип объекта. orders Обязательный параметр
id – Идентификатор объекта Обязательный параметр
Атрибуты
code – Код заказа. Необязательный атрибут
status - ASSEMBLE Обязательный атрибут
numberOfSpace - Количество мест Обязательный атрибут

 Запрос
https://kaspi.kz/shop/api/v2/orders
POST /api/v2/orders
HTTP/1.1
Host: kaspi.kz/shop
Content-Type: application/vnd.api+json
X-Auth-Token:token
{ 
"data":
{
"type": "orders",
"id": "MjAwNTcwMDM=",
"attributes": {
"status": "ASSEMBLE",
"numberOfSpace": "2"
}
}
}
 Ответ
{
"data": {
"type": "orders",
"id": "MjAwNTcwMDM=",
"attributes": {
"code": "20049002",
"status": "ASSEMBLED"
},
"relationships": {
"entries": {
"links": {
"self": "/v2/orders/MjAwNTcwMDM=/relationships/entries",
"related": "/v2/orders/MjAwNTcwMDM=/entries"
}
}
}
}
},

Завершение заказа

Описание
Данный запрос изменяет статус заказа на Выдан
Заголовки
X-Security-Code – секретный код, который был выслан клиенту
X-Send-Code – значение всегда true
Параметры
type – Тип объекта. orders Обязательный параметр
id – Идентификатор объекта Обязательный параметр
Атрибуты
code – Код заказа. Необязательный атрибут
status - Обязательный атрибут

Для завершения заказа:

  1. Первым запросом отправляете COMLETED (ИИН не требуется, значение для X-Doc-Number оставляете пустым)
  2. На номер покупателя будет отправлен секретный СМС-код
  3. После того, как покупатель сообщит СМС-код, отправляете повторный запрос со значением X-Security-Code


 Запрос
https://kaspi.kz/shop/api/v2/orders
POST /api/v2/orders
HTTP/1.1
Host: kaspi.kz/shop
Content-Type: application/vnd.api+json
X-Auth-Token:token
X-Security-Code: 1234
X-Send-Code: true
{
"data": {
"type": "orders",
"id": "MjAwNTcwMDN=",
"attributes": {
"code": "20049000",
"status": "COMPLETED"
}
}
 Ответ
{
"data": {
"type": "orders",
"id": "MjAwNTcwMDN=",
"attributes": {
"code": "20049000",
"status": "COMPLETED"
},
"relationships": {
"entries": {
"links": {
"self": "/v2/orders/MjAwNTcwMDN=/relationships/entries",
"related": "/v2/orders/MjAwNTcwMDN=/entries"
}
}
}
}
},

Отмена заказа

Описание
Данный запрос изменяет статус заказа на Отменен.
Параметры
type – Тип объекта. orders Обязательный параметр
id – Идентификатор объекта Обязательный параметр
Атрибуты
code – Код заказа. Необязательный атрибут
status - Обязательный атрибут
CANCELLED – Заказ отменен. Может быть использован, только если текущий статус ACCEPTED_BY_MERCHANT или APPROVED_BY_BANK
cancellationReason – Причина отмены. Необходим только при статусе заказа CANCELLED. Может принимать одно из следующих значений:
• BUYER_CANCELLATION_BY_MERCHANT – Отказ покупателя
• BUYER_NOT_REACHABLE – Не удалось дозвониться до покупателя
• MERCHANT_OUT_OF_STOCK – Нет в наличии
cancellationComment – Комментарий при отмене заказа. Может быть выставлен только при статусе заказа CANCELLED. Не должен быть больше 1000-ти знаков.

 Запрос
https://kaspi.kz/shop/api/v2/orders
POST /api/v2/orders
HTTP/1.1
Host: kaspi.kz/shop
Content-Type: application/vnd.api+json
X-Auth-Token:token
{
"data": {
"type": "orders",
"id": "MjAwNTcwDFM=",
"attributes": {
"code": "21249002",
"status":"CANCELLED",
"cancellationReason": "BUYER_CANCELLATION_BY_MERCHANT"
}
}
 Ответ
{
"data": {
"type": "orders",
"id": "MjAwNTcwDFM=",
"attributes": {
"code": "21249002",
"status": "CANCELLED",
"cancellationReason": "BUYER_CANCELLATION_BY_MERCHANT"
},
"relationships": {
"entries": {
"links": {
"self": "/v2/orders/MjAwNTcwDFM=/relationships/entries",
"related": "/v2/orders/MjAwNTcwDFM=/entries"
}
}
}
}
},

Получение отзывов

Получение списка отзывов о продавце по всем заказам за период

Описание
Данный запрос возвращает список отзывов о продавце, оставленных покупателями по всем заказам за период. Содержит пользователя, текст отзыва, оценку и номер заказа.
Параметры
page[number]
Номер страницы, начиная с нуля. Обязательный параметр
page[size]
Количество результатов запроса. Максимальное значение равно 1000. Обязательный параметр.
filter[merchantreviews][quality] Тип отзывов. Перечисляемый тип, может иметь одно из следующих значений:
· POSITIVE – положительные отзывы это с оценками больше 3 звезд
· NEGATIVE – отрицательные отзывы это с оценками меньше или равно 3 звезды
filter[merchantreviews][approvedDate][$ge]
Начальная дата поиска отзывов. Указывается в миллисекундах. Обязательный параметр.
filter[merchantreviews][approvedDate][$le]
Конечная дата поиска отзывов. Указывается в миллисекундах. Обязательный параметр.
Атрибуты
orderNumber– номер заказа
rating – рейтинг заказа
comment – текст отзыва
userName – пользователь системы, оставивший отзыв.
Ссылки
self – ссылка, указывающая на сам отзыв. По ней можно будет получить данный конкретный отзыв.

 Запрос
GET
https://kaspi.kz/shop/api/v2/merchantreviews/?page[number]=0&page[size]=20
&filter[merchantreviews][approvedDate][$ge]=1478736000000
&filter[merchantreviews][approvedDate][$le]=1479945600000&filter[merchantreviews][quality]=NEGATIVE
Content-Type: application/vnd.api+json
X-Auth-Token: token
 Ответ
{
"data": {
"type": "merchantreviews",
"id": "bWVyY2hhbnRSZXZpZXdPcmRlcjE1",
"attributes": {
"rating": 4,
"comment": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas ut est. Donec suscipit. Donec eget diam vitae purus condentum adipiscing. Suspendisse lorem diam, cursus non,aliquam et, blandit ac, orci. Phasellus malesuada orci sit amet lorem. Sed egestas tortor eget ipsum. Cras mattis,lorem sit amet congue condimentum, nibh tellus sodales augue, ac euismod lectus arcu eu purus. Mauris tellus ligula,molestie vel, cursus at, eleifend ut, diam. Integer felis. Morbi sapien massa, iaculis id, convallis in, laoreet id, leo.Nullam id metus. Suspendisse turpis tellus, fermentum mollis,scelerisque fermentum, hendrerit sed, mi. Pellentesque bibendum.Mauris sit amet dolor. Praesent ullamcorper accumsan purus. Aliquam erat volutpat. Vivamus a sapien sed dui faucibus porttito.",
"userName": "Stefan Reviewer"
},
"relationships": {
"order": {
"links": {
"self": "/v2/merchantreviews/bWVyY2hhbnRSZXZpZXdPcmRlcjE1/relationships/order",
"related": "/v2/merchantreviews/bWVyY2hhbnRSZXZpZXdPcmRlcjE1/order"
},
"data": {
"type": "orders",
"id": "bWVyY2hhbnRSZXZpZXdPcmRlcjE1"
}
}
},
"links": {
"self": "/v2/merchantreviews/bWVyY2hhbnRSZXZpZXdPcmRlcjE1"
}
},
"included": []
}

Получение отзыва о продавце по конкретному идентификатору заказа

Описание
Данный запрос возвращает отзыв о продавце по конкретному заказу. Содержит пользователя, текст отзыва, оценку и номер заказа.
Параметры
orderId - Идентификатор заказа. Обязательный параметр пути
Атрибуты
orderNumber – номер заказа rating – рейтинг заказа comment – текст отзыва
userName – пользователь системы, оставивший отзыв.
Ссылки
self – ссылка, указывающая на сам отзыв. По ней можно будет получить данный конкретный отзыв.

 Запрос
GET
https://kaspi.kz/shop/api/v2/merchantreviews/bWVyY2hhbnRSZXZpZXdPcmRlcjE=
Content-Type: application/vnd.api+json
X-Auth-Token: token
 Ответ
{
"data": {
"type": "merchantreviews",
"id": "bWVyY2hhbnRSZXZpZXdPcmRlcjE1",
"attributes": {
"rating": 4,
"comment": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas ut est. Donec suscipit. Donec eget diam vitae purus condentum adipiscing. Suspendisse lorem diam, cursus non,aliquam et, blandit ac, orci. Phasellus malesuada orci sit amet lorem. Sed egestas tortor eget ipsum. Cras mattis,lorem sit amet congue condimentum, nibh tellus sodales augue, ac euismod lectus arcu eu purus. Mauris tellus ligula,molestie vel, cursus at, eleifend ut, diam. Integer felis. Morbi sapien massa, iaculis id, convallis in, laoreet id, leo.Nullam id metus. Suspendisse turpis tellus, fermentum mollis,scelerisque fermentum, hendrerit sed, mi. Pellentesque bibendum.Mauris sit amet dolor. Praesent ullamcorper accumsan purus. Aliquam erat volutpat. Vivamus a sapien sed dui faucibus porttito.",
"userName": "Stefan Reviewer"
},
"relationships": {
"order": {
"links": {
"self": "/v2/merchantreviews/bWVyY2hhbnRSZXZpZXdPcmRlcjE1/relationships/order",
"related": "/v2/merchantreviews/bWVyY2hhbnRSZXZpZXdPcmRlcjE1/order"
},
"data": {
"type": "orders",
"id": "bWVyY2hhbnRSZXZpZXdPcmRlcjE1"
}
}
},
"links": {
"self": "/v2/merchantreviews/bWVyY2hhbnRSZXZpZXdPcmRlcjE1"
}
},
"included": []
}
  • No labels