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 basit bir eklenti sayesinde sitenizden yönetebilirsiniz. Sizin oluşturduğumuz bu eklenti tüm kargo takip işlemlerini sizin için sağlayacaktır.

KargomNerede Kargo Takip API Nedir ?

KargomNerede sistemlerine bağlı olarak çalışan bir kod eklentisidir. Sitenize çeşitli methodlarla dahil olarak sorgulama ekranı sunmakta ve takip numarası üzerinden kargo hareketlerini listelemektedir.

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

1. Kullanabileceğiniz Firmaların Listesi

Kargo Takip API sisteminde endpointlerdeki companyId alanına aşağıdaki tabloda bulunan firma id'lerini kullanarak sorgulama yapabilirsiniz.

IDKargo Firması
1Aras Kargo
2Yurtiçi Kargo
6Sürat Kargo
4PTT Kargo
3MNG Kargo
10HepsiJet
9Trendyol Express
5UPS Kargo
27Aramex
15Kolay Gelsin
12ByExpress Kargo
37Kargomsende
25Jetizz
29Aras Kurye
24KargoIst
17Yanwen
19AliExpress / Cainiao
7TNT Kargo
21İnter Global Kargo
8DHL Kargo
13Fedex
30China Ems
32China Post

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.

StatüAçıklama
0Bilinmiyor
1Yolda
2Dağıtımda
3Teslimat Şubesinde
4Teslim Edildi
5Çıkış Biriminde
6Hata (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/getall

Örnek İstek

Header
ApiKey: api_key

Body
{
  search: 'Ayakkabı', // Kargo adında arama
  companyIds: [
    1  // (Aras Kargo) Kargo firmaları Int Array olarak sorgulama 
  ],
  statusTypes: [
    "4" // (Teslim Edildi) Kargo statülerine göre sorgulama
  ]
}

Başarılı Cevap

{
    value: [
        {
            id: number,
            userId: number,
            name: string,
            barcode: string,
            isActive: boolean,
            cargo: {
                barcode: string,
                isDelivered: boolean,
                companyId: number,
                companyName: string,
                companyImage: string,
                statusDescription: string,
                status: string,
                date: datetime,
                longitude: number,
                latitude: number,
                name: string,
                code: string,
                shareUrl: string,
                additionalData: string
            },
            companyId: number,
            isDelivered: boolean,
            customerEmail: string,
            customerName: string,
            customerPhoneNumber: string,
            orderNumber: string,
            notificationEnable: boolean
        }
    ],
    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/query

Örnek İstek

Header
ApiKey: api_key

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

Başarılı Cevap

{
    value: [
        {
            value: {
                isSaved: boolean,
                isFirstSave: boolean,
                newCreated: boolean,
                name: string,
                id: number,
                isActive: boolean,
                barcode: string,
                companyId: number,
                companyName: string,
                companyImage: string,
                isDelivered: boolean,
                deliveredTo: string,
                statusDescription: string,
                receiver: string,
                sender: string,
                senderAddress: string,
                sendDate: datetime,
                receiverAddress: string,
                code: string,
                shareUrl: string,
                deliveredDate: datetime,
                additionalData: string,
                branchDeparture: string,
                branchDelivery: string,
                movement: [
                    {
                        id: numeric,
                        isActive: boolean,
                        description: string,
                        detailDescription: string,
                        title: string,
                        date: datetime,
                        branch: string,
                        province: string,
                        district: string,
                        externalLocation: string,
                        status: string
                    }
                ],
                customerEmail: string,
                customerName: string,
                customerPhoneNumber: string,
                orderNumber: 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,
      companyId: number,
    }
  ]
}

Başarılı Cevap

{
    value: [
        {
            value: {
                isSaved: boolean,
                isFirstSave: boolean,
                newCreated: boolean,
                name: string,
                id: number,
                isActive: boolean,
                barcode: string,
                companyId: number,
                companyName: string,
                companyImage: string,
                isDelivered: boolean,
                deliveredTo: string,
                statusDescription: string,
                receiver: string,
                sender: string,
                senderAddress: string,
                sendDate: datetime,
                receiverAddress: string,
                code: string,
                shareUrl: string,
                deliveredDate: datetime,
                additionalData: string,
                branchDeparture: string,
                branchDelivery: string,
                movement: [
                    {
                        id: numeric,
                        isActive: boolean,
                        description: string,
                        detailDescription: string,
                        title: string,
                        date: datetime,
                        branch: string,
                        province: string,
                        district: string,
                        externalLocation: string,
                        status: string
                    }
                ],
                customerEmail: string,
                customerName: string,
                customerPhoneNumber: string,
                orderNumber: 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: boolean,
    success: true,
    message: İşlem başarılı
}

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

GET 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ı
}

İlgili Sayfa Anahtar Kelimeler

  • Kargo Takip API

  • Kargo Takip API dökümantasyonu