Бізге әлеуметтік желілерде қосылыңыз

Алдын ала тапсырыс беру API

Клиенттік API біздің жүйеде алдын-ала тапсырыс жасау мүмкіндігін ұсынады.

Алдын ала тапсырыс беру - құру

POST https://cabinet-api.exline.kz/api/client/v1/preorders?secret=xxxxxxxxxxxxxxx

Сұрау денесінде параметрлер жиынтығымен json preorder нысанын беру керек:

sender: Жөнелтушінің атауы (string)
origin_region: Жинау қаласының ОКАТО коды немесе атауы (string)
origin_region_id: Жинау қаласының идентифиакторы (int)
origin_address: Алым мекенжайы (string)
receiver: Алушының атауы (string)
destination_region: Жеткізу қаласы ОКАТО коды (string)
destination_region_id: Жеткізу қаласының идентифиакторы (int)
destination_address: Жеткізу мекенжайы (string)
customer_iin: Төлеушінің ЖСН немесе БСН (string)
client_code: Сіздің жүйеңіздегі тапсырыс нөмірі, ол біздің жүйеде бөлек өріске жазылады, оның негізінде шот-фактура нөмірі жасалады. Сондай ақ шот фактураны ref_number және шот фактура нөмірі бойынша іздеуге болады (string)
weight: Салмағы (кг) (float)
receiver_phone: Алушының байланыс телефоны (string)
price: Міндеті емес. Бағалау құны есептелетін тауардың бағасы (integer)
service: Міндеті емес. Қол жетімді опциялар: 'standard' немесе 'express' (string)
comment: Міндетті емес. Пікір (string)
sender_phone: Жіберушінің байланыс телефоны (string)
note: Міндетті емес. Инвестицияланған өнімнің сипаттамасының мысалы (string)
quantity: Міндетті емес. Саны (integer)
desire_date: Міндетті емес. Болжалды жинау күні (string), мысал: "2018 -05-30"

Сұрау мысалы:

https://cabinet-api.exline.kz/api/client/v1/preorders?secret=123456

Ішінде json объект:

        
{
  "preorder":
  {
    "sender":"Иванов Иван",
    "origin_region":"750000000",
    "origin_address":"Абая 153",
    "sender_phone":"+7(121)1234567",
    "receiver":"Петров Петр",
    "destination_region":"591010000",
    "destination_address":"Бокейханова 17",
    "weight":1.3,
    "client_code":"YOUR_ORDER_NUMBER",
    "customer_iin":"123456789012",
    "receiver_phone":"+7(121)1234567, +7 (727) 123-45-67",
    "comment":"Комментарий",
    "note":"Iphone X; Телефон",
    "quantity":2,
    "price": 400000,
    "desire_date":"2018-05-30"
  }
}
      
     

Сервердің жауабы:

        
{
  "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. 1. "error": "Wrong credentials (secret)" - қате secret немесе оның болмауы
  2. 2. "error": "The :key must be a string.", "The :key field is required." - параметрлерді валидациялау, жарамсыздықтың параметрі мен түрі көрсетіледі
  3. 3. "error": "origin_region_uniquness_violation" - КАТО коды бойынша 1-ден астам елді мекен табылды.
  4. 4. "error": "destination_region_uniquness_violation" - КАТО коды бойынша 1-ден астам елді мекен табылды.
  5. 5. "error": "origin_region_not_found" - КАТО коды бойынша бірде бір елді мекен табылған жоқ.
  6. 6. "error": "destination_region_not_found" - КАТО коды бойынша бірде бір елді мекен табылған жоқ.
  7. 7. "error": "customer_not_found" - ЖСН немесе БСН берілген төлеуші табылмады
  8. 8. "error": "service_not_found" - егер қызмет берілсе, бірақ мұндай қызмет жоқ
  9. 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. 1. "error": "preorder_not_found" - мұндай клиент нөмірімен алдын ала тапсырыс табылмады
  2. 2. "error": "preorder_already_completed" - алдын ала тапсырыс табылды, бірақ оның негізінде шот-фактура жасалды. Қызметкерлерге бұл тапсырысты жөнелтушіге қайтару қажет екендігі туралы хабарланады. Алдын ала өтінім мәртебесі қалады completed
  3. 3. "error": "preorder_already_declined" - алдын ала тапсырыс табылды және мәртебесі бар отменен