Gönderi İptali

Gönderi İptali

Bu API, belirli bir gönderiyi iptal etmek için kullanılır.

Endpoint Bilgileri

  • URL: {{BASE_URL}}/api/v1/consignments/{consignment_id}/cancel
  • HTTP Metodu: POST
  • İçerik Türü: application/json
  • Kimlik Doğrulama Tipi: APIKEY

İstek Parametreleri

Query Parametreler

Parametre Adı Parametre Tipi Zorunluluk Açıklama
consignment_id Integer ZORUNLU İptal edilecek gönderi ID'si

Örnek Kullanım

API İsteği

Aşağıda, API isteği için bir örnek HTTP raw request bulunmaktadır. 

POST {{BASE_URL}}/api/v1/consignments/123123/cancel
Content-Type: application/json
APIKEY: {{APIKEY}}

API Cevabı

Başarılı bir istekte, API aşağıdaki gibi bir yanıt döndürecektir:

{
    "status": true,
    "message": "Cancelled by customer",
    "data": {
        "consignment": 632236
    }
}

Hata Cevapları

API isteği başarısız olursa, API aşağıdaki gibi bir hata yanıtı döndürecektir:

{
    "status": false,
    "errors": [
        {
            "message": "Konsinye bulunamadı"
        }
    ]
}