Geliştiriciler
multikolay.com
BaşlangıçTema geliştirmeAPI referansıWebhook'larDeğişiklikler
Siparişler

Kargoya ver

POST
/v1/siparisler/{id}/kargo

Gönderilmemiş bütün kalemler için gönderi açar. elle: takip numarası sizden; uygulama: mağazadaki kargo uygulamasıyla firmada gönderi açılır ve takip numarası firmadan gelir.

Kimlik doğrulama

anahtar
headerKimlik doğrulamaBearer <anahtar>

Panel → Ayarlar → API anahtarları (mk_canli_…). Denemek için paylaşılan test mağazası: mk_test_… anahtarları yalnız orada; herkese açık deneme anahtarı silme yapamaz, IP başına dakikada 60 istek; mağaza her gece 03.00'te (TSİ) baştan kurulur.

Yol parametreleri

id*string

Başlık parametreleri

Idempotency-Key?string

Aynı anahtar ve aynı istek 24 saat içinde tekrar gelirse iş yeniden yapılmaz, ilk yanıt döner. Ağ hatasında güvenle yeniden denemek için.

Uzunluklength <= 255

İstek gövdesi

application/json
  1. body
yol?string

elle: takip numarasını siz verirsiniz. uygulama: mağazada açık kargo uygulamasıyla (Yurtiçi, Aras, DHL…) gönderi açılır.

Varsayılan"elle"
Değerlerden biri"elle""uygulama"
firma*string

elle: firma adı (ör. "Yurtiçi Kargo"); uygulama: uygulama kimliği (ör. "yurtici")

Uzunluk1 <= length <= 80
takip_no?string
Uzunluklength <= 80
takip_url?string
Biçimuri
musteriye_bildir?boolean

"Kargoya verildi" e-postası gitsin mi

Varsayılantrue
desi?number
Aralık0 < value
kg?number
Aralık0 < value
paket_adedi?integer
Aralık0 < value

Yanıt gövdesi

Başarılı

application/json
  1. response
id*string
no*string

Müşterinin gördüğü numara

durum*string
Değerlerden biri"odeme_bekliyor""hazirlaniyor""kargoda""teslim_edildi""iptal""iade"
para_birimi*string
urun_toplam*integer

Kuruş, KDV dahil (184990 = 1.849,90 ₺)

indirim_toplam*integer

Kuruş, KDV dahil (184990 = 1.849,90 ₺)

kargo_toplam*integer

Kuruş, KDV dahil (184990 = 1.849,90 ₺)

toplam*integer

Kuruş, KDV dahil (184990 = 1.849,90 ₺)

odenen*integer

Kuruş, KDV dahil (184990 = 1.849,90 ₺)

iade_edilen*integer

Kuruş, KDV dahil (184990 = 1.849,90 ₺)

indirim_kodlari*array<string>
musteri*
teslimat_adresi*|null
fatura_adresi*|null
kalemler*array<>
odemeler*array<>
gonderiler*array<>
kaynak*string

vitrin, panel (taslak sipariş), aktarim…

iptal*|null
olusturma*string

ISO 8601, UTC

guncelleme*string

ISO 8601, UTC

Örnek istek
curl -X POST 'https://api.multikolay.com/v1/siparisler/string/kargo' \  -H 'Content-Type: application/json' \  -d '{  "firma": "string"}'
Örnek yanıt
{  "id": "string",  "no": "string",  "durum": "odeme_bekliyor",  "para_birimi": "string",  "urun_toplam": 0,  "indirim_toplam": 0,  "kargo_toplam": 0,  "toplam": 0,  "odenen": 0,  "iade_edilen": 0,  "indirim_kodlari": [    "string"  ],  "musteri": {    "id": "string",    "eposta": "string"  },  "teslimat_adresi": {    "ad": "string",    "soyad": "string",    "sirket": "string",    "telefon": "string",    "satir1": "string",    "satir2": "string",    "ilce": "string",    "il": "string",    "posta_kodu": "string",    "ulke": "string",    "fatura_tipi": "bireysel",    "tckn": "string",    "vergi_no": "string",    "vergi_dairesi": "string"  },  "fatura_adresi": {    "ad": "string",    "soyad": "string",    "sirket": "string",    "telefon": "string",    "satir1": "string",    "satir2": "string",    "ilce": "string",    "il": "string",    "posta_kodu": "string",    "ulke": "string",    "fatura_tipi": "bireysel",    "tckn": "string",    "vergi_no": "string",    "vergi_dairesi": "string"  },  "kalemler": [    {      "id": "string",      "urun_id": "string",      "varyant_id": "string",      "ad": "string",      "varyant_ad": "string",      "sku": "string",      "adet": 0,      "birim_fiyat": 0,      "indirim": 0,      "toplam": 0,      "kdv_orani": 0,      "gonderilen": 0,      "teslim_edilen": 0,      "iade_edilen": 0    }  ],  "odemeler": [    {      "id": "string",      "yontem": "kart",      "saglayici": "string",      "durum": "string",      "tutar": 0,      "olusturma": "string"    }  ],  "gonderiler": [    {      "id": "string",      "firma": "string",      "takip_no": "string",      "takip_url": "string",      "durum": "hazirlaniyor",      "kalemler": [        {          "kalem_id": "string",          "adet": 0        }      ],      "sevk": "string",      "teslim": "string",      "olusturma": "string"    }  ],  "kaynak": "string",  "iptal": "string",  "olusturma": "string",  "guncelleme": "string"}

İadeyi getir GET

Önceki

Teslim edildi olarak işaretle POST

Sonraki