Қаз
Қаз
Бізге әлеуметтік желілерде қосылыңыз
Алдын ала тапсырыс беру API
Сұрауларда міндетті түрде мына тақырып көрсетіледі:
Accept: application/json Клиенттік API біздің жүйеде алдын-ала тапсырыс жасау мүмкіндігін ұсынады.
Алдын ала тапсырыс беру - құру
POST https://cabinet-api.exline.kz/api/client/v1/preorders?secret=xxxxxxxxxxxxxxx Сұрау денесінде параметрлер жиынтығымен json preorder нысанын беру керек:
sender: Жөнелтушінің атауы (string), max: 255
origin_region: Жинау қаласының КАТО коды немесе атауы (string), max: 255. Егер origin_region_id параметрі жоқ болса, міндетті. КАТО коды немесе өңір атауы "Елді мекендердің API" анықтамалығындағы деректермен сәйкес келуі керек. КАТО коды барлық өңірлерде көрсетілмеген. Өңірді дәлірек анықтау үшін origin_region_id параметрін пайдалану ұсынылады.
origin_region_id: Жинау қаласының идентификаторы (int), егер origin_region параметрі жоқ болса, міндетті. Өңір идентификаторын "Елді мекендердің API" анықтамалығынан алуға болады.
origin_address: Жинау мекенжайы (string), max: 255
receiver: Алушының атауы (string), max: 255
destination_region: Жеткізу қаласының КАТО коды немесе атауы (string), max: 255. Егер destination_region_id параметрі жоқ болса, міндетті. КАТО коды немесе өңір атауы "Елді мекендердің API" анықтамалығындағы деректермен сәйкес келуі керек. КАТО коды барлық өңірлерде көрсетілмеген. Өңірді дәлірек анықтау үшін destination_region_id параметрін пайдалану ұсынылады.
destination_region_id: Жеткізу қаласының идентификаторы (int), егер origin_region параметрі жоқ болса, міндетті. Өңір идентификаторын "Елді мекендердің API" анықтамалығынан алуға болады.
destination_address: Жеткізу мекенжайы (string), max: 255
customer_iin: Төлеушінің ЖСН немесе БСН, тек сандар, min: 6, max: 14. Көрсетілген ЖСН немесе БСН төлеуші біздің жүйеде тіркелуі керек.
client_code: Сіздің жүйедегі тапсырыс нөмірі, ол біздің жүйедегі бөлек өріске жазылады, оның негізінде жүкқұжат нөмірі жасалады. (string), max: 255
weight: Салмақ, кг (float)
receiver_phone: Алушының байланыс телефоны (string), max: 255
price: Міндетті емес. Бағалау құны есептелетін тауардың бағасы (float), егер көрсетілсе, 0-ден үлкен болуы керек.
service: Міндетті емес. Қолжетімді нұсқалар: 'standard', 'express_mail', 'express_parcels'
comment: Міндетті емес. Жүкқұжатқа арналған түсініктеме (string), max: 255
sender_phone: Жөнелтушінің байланыс телефоны (string), max: 255
note: Міндетті емес өріс. Өтінімге арналған ескертпе. Мысалы, салынған тауардың сипаттамасы (string), max: 255
quantity: Міндетті емес. Сан (int)
desire_date: Міндетті емес. Жинаудың болжамды күні (date), мысалы: "2018-05-30"
parcels: Міндетті емес. Жөнелтімдер тізімі (array)
Сұрау мысалы:
https://cabinet-api.exline.kz/api/client/v1/preorders?secret=123456 Ішінде json объект:
{
"preorder":
{
"sender": "John Doe",
"origin_region": "750000000",
"origin_address": "Main St, 123",
"sender_phone": "+7 (777) 1234567",
"receiver": "Jane Doe",
"destination_region": "591010000",
"destination_address": "Second Ave, 345",
"weight": 1.3,
"client_code": "YOUR_ORDER_NUMBER",
"customer_iin": "123456789012",
"receiver_phone": "+7 (777) 1234567, +7 (727) 123-45-67",
"comment": "Комментарий",
"note": "Iphone X; Телефон",
"quantity": 2,
"price": 400000,
"desire_date": "2018-05-30",
"parcels": [
{
"code": "2400042220776",
"weight": "0.3"
}
]
}
}
Сервердің жауабы:
{
"preorder": {
"id": 20,
"waybill_name": "950562018985",
"created_at": "2018-02-02T03:20:05.459Z",
"link_to_pdf": "https://cabinet-api.exline.kz/storage/api/950562018985.pdf"
}
}
Қателер
Төменде алдын ала өтінім жасауға тырысқан кездегі қателіктер тізімі берілген. Барлық қателер нысанда жіберіледі error.
- 1. "error": "Wrong credentials (secret)" - қате secret немесе оның болмауы
- 2. "error": "The :key must be a string.", "The :key field is required." - параметрлерді валидациялау, жарамсыздықтың параметрі мен түрі көрсетіледі
- 3. "error": "origin_region_uniquness_violation" - КАТО коды бойынша 1-ден астам елді мекен табылды.
- 4. "error": "destination_region_uniquness_violation" - КАТО коды бойынша 1-ден астам елді мекен табылды.
- 5. "error": "origin_region_not_found" - КАТО коды бойынша бірде бір елді мекен табылған жоқ.
- 6. "error": "destination_region_not_found" - КАТО коды бойынша бірде бір елді мекен табылған жоқ.
- 7. "error": "customer_not_found" - ЖСН немесе БСН берілген төлеуші табылмады
- 8. "error": "service_not_found" - егер қызмет берілсе, бірақ мұндай қызмет жоқ
- 9. "error": "duplication_client_code_error" - мұндай нөмірмен алдын ала өтінім біздің жүйеде бұрыннан бар
Алдын ала тапсырыс беру - жою
Егер сіз алдын ала берілген тапсырысты жойсаңыз, онда оның негізінде жасалған өтініш те бірге жойылады. Егер тапсырыстың статусы "Жіберілімдер жиналды" немесе "Тапсырыс жабылды" болса, онда алдын ала берілген өтінішті жоюға болмайды.
POST https://cabinet-api.exline.kz/api/client/v1/preorders/decline?secret=xxxxxxxxxxxxxxx Сұрау денесінде параметрлер жиынтығымен json preorder нысанын беру керек:
client_code: Іздеу жүргізілетін тапсырыс нөмірі (string) Сұрау мысалы:
https://cabinet-api.exline.kz/api/client/v1/preorders/decline?secret=123456 Ішінде json объект:
{
"preorder":
{
"client_code":"YOUR_ORDER_NUMBER"
}
}
Сервердің жауабы:
{
"preorder": {
"id": 9,
"created_at": "2018-01-26T09:13:38.194Z",
"declined_at": "2018-01-29T06:53:56.300Z"
}
}
Қателер
Төменде алдын ала өтінім жасауға тырысқан кездегі қателіктер тізімі берілген. Барлық қателер нысанда жіберіледі error.
- 1. "error": "preorder_not_found" - мұндай клиент нөмірімен алдын ала тапсырыс табылмады
- 2. "error": "preorder_already_completed" - алдын ала тапсырыс табылды, бірақ оның негізінде шот-фактура жасалды. Қызметкерлерге бұл тапсырысты жөнелтушіге қайтару қажет екендігі туралы хабарланады. Алдын ала өтінім мәртебесі қалады
completed - 3. "error": "preorder_already_declined" - алдын ала тапсырыс табылды және мәртебесі бар
отменен
ExLine - сенімді жеткізу желісі!
