Kargo Takip API Dökümantasyonu

Kargo sorgulama alt yapımızı müşterilerine gelişmiş kargo takip hizmeti sunmak isteyen firmalara açıyoruz. Kargo takip işlemlerini aşağıdaki dökümantasyonla beraber sisteminize entegre edebilirsiniz. Anlık webhooklarla kullanıcılarınızı bilgilendirebilirsiniz.

Kargo Takip API Dökümantasyonu İçeriği

  • 1. Kargo Firmaları
  • 2. Kargo Statüleri
  • 3. Kargo Listesi
  • 4. Kargo Ekle
  • 5. Eklenen Kargoyu Tekrar Sorgulama
  • 6. Kargo Bilgileri Getir
  • 7. Kargo Bilgileri Düzenle
  • 8. Kargo Sil
  • 9. Webhook Tanımlama

1. Kullanabileceğiniz Firmaların Listesi

Kargo Takip API sisteminde endpointlerdeki companySlug alanına aşağıdaki tabloda bulunan firma slug'larını kullanarak sorgulama yapabilirsiniz.

SlugKargo Firması
aras-kargoAras Kargo
yurtici-kargoYurtiçi Kargo
surat-kargoSürat Kargo
ptt-kargoPTT Kargo
mng-kargoMNG Kargo
hepsijet-kargoHepsiJet
trendyol-expressTrendyol Express
ups-kargoUPS Kargo
aramexAramex
kolaygelsinKolay Gelsin
kargomsendeKargomsende
jetizzJetizz
aras-kuryeAras Kurye
kargoistKargoIst
netkargoNetKargo
aliexpress-cainiaoAliExpress / Cainiao
tntTNT Kargo
inter-global-kargoİnter Global Kargo
dhlDHL
china-emsChina Ems
yanwenYanwen
canadapostCanadapost
ups-globalUps Global
purolatorPurolator
poste-italianePoste-Italiane
deutsche-postDeutsche Post
uk-mailUk Mail
sendeo-kargoSendeo Kargo
gkn-kargoGkn Kargo

2. Kargo Statüleri Listesi

Kargo Takip API sisteminde endpoint'lerdeki status veya statusType alanına aşağıdaki tabloda bulunan statüleri kullanarak filtreleme yapabilir veya gelen response yorumlayabilirsiniz.

SlugAçıklama
in-output-unitÇıkış Biriminde
transitYolda
delivery-branchTeslimat Şubesinde
out-for-deliveryDağıtımda
deliveredTeslim Edildi
unknownBilinmiyor
errorHata (Teslim Edilemedi, Kayıp vs.)

3. Kargo Listesi

Kargo Takip API sisteminde erişim sağladığınız hesaba ait kargoların listenmesini sağlamaktadır.

İstek Adresi

POST https://api.kargomnerede.co/api/customer/cargo/getall

Örnek İstek

Header
ApiKey: api_key

Body
{
  search: 'Ayakkabı', // Kargo adında arama
  companySlugs: [
    "aras-kargo"  // (Aras Kargo) Kargo firmasına göre sorgulama 
  ],
  statusSlugs: [
    "delivered" // (Teslim Edildi) Kargo statülerine göre sorgulama
  ]
}

Başarılı Cevap

{
    value: [
        {
            id: number,
            name: string,
            barcode: string,
            companyId: number,
            companySlug: string,
            isDelivered: boolean,
            customerEmail: string,
            customerName: string,
            customerPhoneNumber: string,
            orderNumber: string,
            notificationEnable: boolean,
            cargo: {
                barcode: string,
                isDelivered: boolean,
                companyId: number,
                companySlug: string,
                companyName: string,
                companyImage: string,
                statusDescription: string,
                status: string,
                statusSlug: string,
                date: datetime,
                name: string,
                code: string,
                shareUrl: string
            }
        }
    ],
    success: true,
    message: Başarılı
}

4. Kargo Ekle

Kargo Takip API sisteminde erişim sağladığınız hesaba kargo eklenmesini sağlamaktadır.

İstek Adresi

POST https://api.kargomnerede.co/api/customer/cargo/add

Örnek İstek

Header
ApiKey: api_key

Body
{
  barcodes: [
    {
      code: string,
      companySlug: string,
      name: string,
      orderNumber: string,
      customerName: string,
      customerPhoneNumber: string,
      customerEmail: string,
      notificationEnable: boolean
    }
  ]
}

Başarılı Cevap

{
    value: [
        {
            value: {
                name: string,
                id: number,
                isActive: boolean,
                barcode: string,
                companyId: number,
                companySlug: string,
                companyName: string,
                companyImage: string,
                isDelivered: boolean,
                statusDescription: string,
                status: string,
                statusSlug: string,
                sender: string,
                senderAddress: string,
                sendDate: datetime,
                receiver: string,
                receiverAddress: string,
                deliveredDate: datetime,
                code: string,
                shareUrl: string,
                customerEmail: string,
                customerName: string,
                customerPhoneNumber: string,
                orderNumber: string,
                movement: [
                    {
                        description: string,
                        detailDescription: string,
                        title: string,
                        date: datetime,
                        externalLocation: string,
                        status: string,
                        statusSlug: string
                    }
                ]
            },
            success: true,
            message: string
        }
    ],
    success: true,
    message: İşlem başarılı
}

5. Eklenen Kargoyu Tekrar Sorgulama

Kargo Takip API sisteminde erişim sağladığınız hesaba ait ilgili kargonun detaylarının listelenmesi sağlamaktadır.

İstek Adresi

POST https://api.kargomnerede.co/api/customer/cargo/query

Örnek İstek

Header
ApiKey: api_key

Body
{
  barcodes: [
    {
      code: string,
      companySlug: string
    }
  ]
}

Başarılı Cevap

{
    value: [
        {
            value: {
                name: string,
                id: number,
                isActive: boolean,
                barcode: string,
                companyId: number,
                companySlug: string,
                companyName: string,
                companyImage: string,
                isDelivered: boolean,
                statusDescription: string,
                status: string,
                statusSlug: string,
                sender: string,
                senderAddress: string,
                sendDate: datetime,
                receiver: string,
                receiverAddress: string,
                deliveredDate: datetime,
                code: string,
                shareUrl: string,
                customerEmail: string,
                customerName: string,
                customerPhoneNumber: string,
                orderNumber: string,
                movement: [
                    {
                        description: string,
                        detailDescription: string,
                        title: string,
                        date: datetime,
                        externalLocation: string,
                        status: string,
                        statusSlug: string
                    }
                ]
            },
            success: true,
            message: string
        }
    ],
    success: true,
    message: İşlem başarılı
}

6. Kargo Bilgileri Getir

Kargo Takip API sisteminde önceden kaydedilen kargonun bilgilerini getirir.

İstek Adresi

POST https://api.kargomnerede.co/api/customer/cargo/getsingle

Örnek İstek

Header
ApiKey: api_key

Body
{
  id: number // Kargo sisteme kaydedilen id'si
}

Başarılı Cevap

{
    value: {
        id: number,
        userId: number,
        name: string,
        barcode: string,
        isActive: boolean,
        companyId: number,
        companySlug: string,
        status: string,
        statusSlug: string,
        isDelivered: boolean,
        customerEmail: string,
        customerName: string,
        customerPhoneNumber: string,
        orderNumber: string,
        notificationEnable: boolean
    },
    "success": boolean,
    "message": string
}

7. Kargo Bilgileri Düzenle

Kargo Takip API sisteminde önceden kaydedilen kargonun bilgilerini düzenler.

İstek Adresi

POST https://api.kargomnerede.co/api/customer/cargo/edit

Örnek İstek

Header
ApiKey: api_key

Body
{
  id: number,
  orderNumber: string,
  customerName: string,
  customerPhoneNumber: string,
  customerEmail: string,
  notificationEnable: boolean
}

Başarılı Cevap

{
    value: boolean,
    success: true,
    message: İşlem başarılı
}

8. Kargo Sil

Kargo Takip API sisteminde önceden kaydedilen kargoyu siler.

İstek Adresi

DELETE https://api.kargomnerede.co/api/customer/cargo/delete

Örnek İstek

Header
ApiKey: api_key

Query Parameters - Integer Array
 https://api.kargomnerede.co/api/customer/cargo/delete?id=number&id=number

Başarılı Cevap

{
    value: boolean,
    success: true,
    message: İşlem başarılı
}

9. Webhook Tanımlama

Webhook tanımlayarak anlık kargo değişikliklerinden kendi sisteminizi haberdar edebilirsiniz.
Kendi sisteminizde tanımladığınız API uç noktasını Kurumsal Dashboard - Ayarlar - Webhook sekmesi altından ekleyebilirsiniz.
Her kargo durum değişikliğinde bu uç noktası çağrılarak sisteminiz bilgilendirilecektir.

Webhook Örneği (Sisteminizde tanımlı API URL)

POST https:/siteniz.com/apiucnokta

Sisteminize Gönderilecek JSON Model

Content-Type
application/json

Request Body
{
  id: number, // Kargonun bizim sistemimizdeki id'si
  barcode: string, // Kargo takip numarası
  statusSlug: string, // Kargonun son durumunun statüsü
  isDelivered: boolean,
  companyName: string,
  description: string, // Kargonun durumu
  location: string, // Kargonun son lokasyonu
  shareUrl: string, // Paylaşım Url
  message: string, // Kullanıcılara gönderilen mesaj içeriği
  orderNumber: string // Kargonun sisteminizdeki sipariş numarası
}

Response Body (Sizin sisteminizden dönen model)

{
  success: boolean
}

İlgili Sayfa Anahtar Kelimeler

  • Kargo Takip API

  • Kargo Takip API dökümantasyonu