logo
Documentation Powered by ReDoc

e-İrsaliye Rest Api Geliştirici Kılavuzu (1.0)

Download OpenAPI specification:Download

Turkcell e-Şirket e-İrsaliye API uç noktalarını, kullanıcı yönetiminden entegrasyon kullanıcısı oluşturarak kullanamaya başlayabilirsiniz. API kullanımı ve entegrasyon süreçlerinize başlamadan önce mutlaka satis@eplatform.com.tr adresinden satış ekibimiz ile iletişime geçmelisiniz.Satın alma süreçlerinden sonra satış temsilcimiz entegrasyon ekibimiz ile iletişime geçecektir. Turkcell e-Şirket bünyesindeki yer alan diğer uygulamaların dökümantasyonlarına https://developer.turkcellesirket.com adresinden ulaşabilirsiniz. Servis uç noktalarımız authentication mekanizması olarak OAuth 2.0 kullanmaktadır.

Canlı ortamı Auth servis adresi; https://core.turkcellesirket.com/v1/token

Test ortamı Auth servis adresi; https://coretest.isim360.com/v1/token

Entegrasyon çalışmalarında yaptığınız işlemlerin sonuçlarını, test portalimizi kullanarak gözlemleyebilirsiniz.

Test arayüz adresi; https://maintest.isim360.com/ 

       Örnek token isteği; 
{
-X POST https://core.turkcellesirket.com/v1/token / 
 -H 'Cache-Control: no-cache' / 
 -H 'Content-Type: application/x-www-form-urlencoded' / 
 -d 'username=yourUserName&password=yourPassword&client_id=serviceApi' 
 }

e-İrsaliye servis adresi: https://eirsaliyeservice.turkcellesirket.com e-İrsaliye servisini kullanarak işlem yapmak için, bu adresi baz alarak işlem gerçekleştirmelisiniz.

Giden e-İrsaliye

e-İrsaliye gönderim ve sorgulama için ortak olan servis uç noktalarını içerir.

Post

UBL oluşturmak istemeyen, Turkcell e-Şirket irsaliye oluşturma arayüzlerininde kullandığı, JSON model vasıtasıyla irsaliye oluşturmak isteyenler için sunulan uç noktasıdır.

Request Body schema: application/json
status
int
Enum: "Taslak : 0" "Kaydet ve Gönder : 20"

İrsaliyenin durumunu belirtir. Oluşturacağınız irsaliyeyi taslak halinde kayıt etmek için 0, kaydedildiği anda, otomatik gönderilmesini istiyorsanız 20 olarak ayarlamanız gerekmektedir.

isNew
bool

Yeni bir irsaliye oluşturuyorsanız, bu alanı true olarak ayarlamalısınız. İrsaliyenizi oluşturup, liste halinde çektikten sonra bu alanı false olarak güncellerseniz, her irsaliye listesi çekildiğinde , isNew alanı false olanlar tekrar tekrar gelmeyecektir.

xsltCode
string

Özel oluşturulmış fatura görünümünü var ise, bu fatura görünümünü kullanmak için, size verilen veya tanımladığınız xsltCode bilgisini bu alan ile göndermelisiniz. Eğer boş gönderirseniz standart fatura görünümü ile faturanız kaydedilir.

localReferenceId
string

Muhasebe/ERP sisteminizde yer alan identifier numarayı bu alanda gönderebilir ve bu alan vasıtasıtasıyla eşleştirebilirsiniz.

useManualDespatchAdviceId
bool

16 haneli irsaliye numarası gönderen tarafından atanacak ise 'true' olarak gönderilmelidir. Örnek irsaliye numarası: EPA2019000001220. 'false' olduğu durumda, sistem tarafından varsayılan seriden bir sonraki numara otomatik verilir.

object

Malları teslim alan taraf bilgisi

object

İrsaliye İçeriklerinin Bulunduğu Alan

Array of objects (DespatchLines)

İrsaliye kalem bilgileri

object

İrsaliye sevkiyat adres bilgilerinin girileceği alan

object

İrsaliyenin taşıyıcı bilgilerinin girildiği alandır.Bu alan için iki senaryo mevcuttur.

1- Taşıma işleminin herhangi bir firma tarafından yapıldığı senaryoda

shipmentSenderTitle ve shipmentSenderTcknVkn zorunludur

2- Taşıma işleminin bir firma tarafından yapılmadığı senaryoda

driverName, driverSurname ve driverTckn (11 haneli ve rakamdan oluşmalıdır. Elinizde bu bilgi bulunmadığında 11 adet 1 girebilirsiniz.) zorunludur

object

İrsaliyenin asıl alıcısının bilgilerinin girildiği alandır.

object

İrsaliyenin asıl sahibinin bilgilerinin girildiği alandır.

object

İrsaliyenin taşıyıcı bilgilerinin girildiği alandır.

Array of objects (CustomDocumentReference)

İrsaliyenin ubl'ine eklemek istediğiniz alanları bu model ile yapabilirsiniz.

Array of objects

İrsaliye içerisinde liste şeklinde not girmek istediğiniz durumlarda bu alanı kullanabilirsiniz.

Responses

Request samples

Content type
application/json
{
  • "status": 20,
  • "isNew": true,
  • "xsltCode": "string",
  • "localReferenceId": "string",
  • "useManualDespatchAdviceId": null,
  • "addressBook": {
    },
  • "generalInfo": {
    },
  • "despatchLines": [
    ],
  • "deliveryAddressInfo": {
    },
  • "despatchShipmentInfo": {
    },
  • "despatchBuyerCustomerInfo": {
    },
  • "sellerSupplierInfo": {
    },
  • "orderInfo": {
    },
  • "customDocumentReferenceList": [
    ],
  • "notes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": null,
  • "despatchAdviceNumber": "string",
  • "status": "Taslak : 0",
  • "localReferenceId": "string"
}

Put

İrsaliye güncelleme methotudur. Turkcell e-Şirket irsaliye güncelleme arayününde kullandığı uç noktasıdır.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

Request Body schema: application/json
status
int
Enum: "Taslak : 0" "Kaydet ve Gönder : 20"

İrsaliyenin durumunu belirtir. Oluşturacağınız irsaliyeyi taslak halinde kayıt etmek için 0, kaydedildiği anda, otomatik gönderilmesini istiyorsanız 20 olarak ayarlamanız gerekmektedir.

isNew
bool

Yeni bir irsaliye oluşturuyorsanız, bu alanı true olarak ayarlamalısınız. İrsaliyenizi oluşturup, liste halinde çektikten sonra bu alanı false olarak güncellerseniz, her irsaliye listesi çekildiğinde , isNew alanı false olanlar tekrar tekrar gelmeyecektir.

xsltCode
string

Özel oluşturulmış fatura görünümünü var ise, bu fatura görünümünü kullanmak için, size verilen veya tanımladığınız xsltCode bilgisini bu alan ile göndermelisiniz. Eğer boş gönderirseniz standart fatura görünümü ile faturanız kaydedilir.

localReferenceId
string

Muhasebe/ERP sisteminizde yer alan identifier numarayı bu alanda gönderebilir ve bu alan vasıtasıtasıyla eşleştirebilirsiniz.

useManualDespatchAdviceId
bool

16 haneli irsaliye numarası gönderen tarafından atanacak ise 'true' olarak gönderilmelidir. Örnek irsaliye numarası: EPA2019000001220. 'false' olduğu durumda, sistem tarafından varsayılan seriden bir sonraki numara otomatik verilir.

object

Malları teslim alan taraf bilgisi

object

İrsaliye İçeriklerinin Bulunduğu Alan

Array of objects (DespatchLines)

İrsaliye kalem bilgileri

object

İrsaliye sevkiyat adres bilgilerinin girileceği alan

object

İrsaliyenin taşıyıcı bilgilerinin girildiği alandır.Bu alan için iki senaryo mevcuttur.

1- Taşıma işleminin herhangi bir firma tarafından yapıldığı senaryoda

shipmentSenderTitle ve shipmentSenderTcknVkn zorunludur

2- Taşıma işleminin bir firma tarafından yapılmadığı senaryoda

driverName, driverSurname ve driverTckn (11 haneli ve rakamdan oluşmalıdır. Elinizde bu bilgi bulunmadığında 11 adet 1 girebilirsiniz.) zorunludur

object

İrsaliyenin asıl alıcısının bilgilerinin girildiği alandır.

object

İrsaliyenin asıl sahibinin bilgilerinin girildiği alandır.

object

İrsaliyenin taşıyıcı bilgilerinin girildiği alandır.

Array of objects (CustomDocumentReference)

İrsaliyenin ubl'ine eklemek istediğiniz alanları bu model ile yapabilirsiniz.

Array of objects

İrsaliye içerisinde liste şeklinde not girmek istediğiniz durumlarda bu alanı kullanabilirsiniz.

Responses

Request samples

Content type
application/json
{
  • "status": 20,
  • "isNew": true,
  • "xsltCode": "string",
  • "localReferenceId": "string",
  • "useManualDespatchAdviceId": null,
  • "addressBook": {
    },
  • "generalInfo": {
    },
  • "despatchLines": [
    ],
  • "deliveryAddressInfo": {
    },
  • "despatchShipmentInfo": {
    },
  • "despatchBuyerCustomerInfo": {
    },
  • "sellerSupplierInfo": {
    },
  • "orderInfo": {
    },
  • "customDocumentReferenceList": [
    ],
  • "notes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": null,
  • "despatchAdviceNumber": "string",
  • "status": "Taslak : 0",
  • "localReferenceId": "string"
}

Update Despatch Status List

Hatalı veya Taslak durumundaki irsaliyelerin statüsünü değiştirmek için kullanılır. Hatalı irsaliyeyi taslağa çekmek, taslaktaki irsaliyeyi kuyruğa eklemek için bu metot kullanılır.

Request Body schema: application/json
any

Ids:[ "dba1c5ea-0229-410a-8193-958ff76b7d19", "dba1c5ea-0229-410a-8193-958ff76b7d19"]

Status: Taslak: 0, Kuyrukla ve Gönder: 20

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "Error": {
    }
}

Post ( UBL )

Giden irsaliyeyi UBL olarak hazırlayanların kullanabileceği uç noktasıdır. Hazırlanan xml, zip'lenerek modelde ilgili alana eklenerek gönderilir.

Request Body schema: application/json
despatchAdviceZip
string

Stringe parse ettiğiniz byte kodu DespatchAdviceZip içerisinde göndermeniz gerekmektedir.

localReferenceId
string

Gönderilen Muhasebe/ERP numarası.

prefix
string

Ön ek (İrsaliye numarasını kendi gönderen firmalar, bu alanı null olarak belirtmelidir, eğer ön ek belirtirlerse ve bu ön ek sistemde tanımlı değilse 'Hiç prefix bulunamadı' uyarısı döner.) İrsaliye numarası sistem tarafından verilecek ise ve sistem üzerinde birden fazla ön ek tanımlatılmış ise , sayacın devam etmesini istediğiniz ön eki belirtmelisiniz, aksi durumda default olarak tanımlı ön ek üzerinden sayaç numara verir.

targetAlias
string

Hedef müşteri posta kutusu. Birden fazla PK adresi olan firmalara kesilecek irsaliyelerde, bu alanı doldurmanız gerekmektedir. Alıcı posta kodu, muhtalif müşteriler için (e-irsaliye müşterisi olmayan) alias değeri urn:mail:irsaliyepk@gib.gov.tr olarak gönderilmeli.

useManualDespatchAdviceId
bool

16 haneli irsaliye numarası UBL içerisinden gönderilirse 'true' olarak set edilmeli. Güncelleme işleminde bu alan false olarak gönderilmelidir.

checkLocalReferenceId
bool

Gönderilen Muhasebe/ERP numarası için mükerrerlik kontrolü yapılmak isteniyorsa bu alan true gönderilmelidir.

status
int
Enum: "Taslak : 0" "Kaydet ve Gönder : 20"

İrsaliyenin durumunu belirtir.

Responses

Request samples

Content type
application/json
{
  • "despatchAdviceZip": "string",
  • "localReferenceId": "string",
  • "prefix": "string",
  • "targetAlias": "string",
  • "useManualDespatchAdviceId": null,
  • "checkLocalReferenceId": null,
  • "status": "Taslak : 0"
}

Response samples

Content type
application/json
{
  • "Id": "string",
  • "DespatchAdviceNumber": null,
  • "Status": "Taslak : 0",
  • "LocalReferenceId": "string"
}

Put ( UBL )

Giden irsaliyeyi UBL olarak hazırlayanların güncelleme için kullanabileceği uç noktasıdır. Post (UBL)'de olduğu gibi, zip'lenerek modelde ilgili alana eklenerek gönderilir.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

Request Body schema: application/json
despatchAdviceZip
string

Stringe parse ettiğiniz byte kodu DespatchAdviceZip içerisinde göndermeniz gerekmektedir.

localReferenceId
string

Gönderilen Muhasebe/ERP numarası.

prefix
string

Ön ek (İrsaliye numarasını kendi gönderen firmalar, bu alanı null olarak belirtmelidir, eğer ön ek belirtirlerse ve bu ön ek sistemde tanımlı değilse 'Hiç prefix bulunamadı' uyarısı döner.) İrsaliye numarası sistem tarafından verilecek ise ve sistem üzerinde birden fazla ön ek tanımlatılmış ise , sayacın devam etmesini istediğiniz ön eki belirtmelisiniz, aksi durumda default olarak tanımlı ön ek üzerinden sayaç numara verir.

targetAlias
string

Hedef müşteri posta kutusu. Birden fazla PK adresi olan firmalara kesilecek irsaliyelerde, bu alanı doldurmanız gerekmektedir. Alıcı posta kodu, muhtalif müşteriler için (e-irsaliye müşterisi olmayan) alias değeri urn:mail:irsaliyepk@gib.gov.tr olarak gönderilmeli.

useManualDespatchAdviceId
bool

16 haneli irsaliye numarası UBL içerisinden gönderilirse 'true' olarak set edilmeli. Güncelleme işleminde bu alan false olarak gönderilmelidir.

checkLocalReferenceId
bool

Gönderilen Muhasebe/ERP numarası için mükerrerlik kontrolü yapılmak isteniyorsa bu alan true gönderilmelidir.

status
int
Enum: "Taslak : 0" "Kaydet ve Gönder : 20"

İrsaliyenin durumunu belirtir.

Responses

Request samples

Content type
application/json
{
  • "despatchAdviceZip": "string",
  • "localReferenceId": "string",
  • "prefix": "string",
  • "targetAlias": "string",
  • "useManualDespatchAdviceId": null,
  • "checkLocalReferenceId": null,
  • "status": "Taslak : 0"
}

Response samples

Content type
application/json
{
  • "Id": "string",
  • "DespatchAdviceNumber": null,
  • "Status": "Taslak : 0",
  • "LocalReferenceId": "string"
}

Get Status

Gönderilen e-irsaliyenin durumunu sorgulayan uç noktasıdır. Gönderilen e-irsaliye durumuna göre envelope (zarf) bilgileri dönmemektedir. Modellerinizi bu hususa göre oluşturmalısınız.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "despatchAdviceNumber": "string",
  • "status": "Taslak : 0",
  • "message": "string",
  • "envelopeId": null,
  • "envelopeStatus": "Zarf kuyruğa Ekledi : 1000",
  • "envelopeMessage": null
}

Get UBL

Giden irsaliye UBL modeli Zip olarak indiren metotdur.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Get PDF

İrsaliyeyi Pdf olarak indirme.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

isStandartXslt
bool

Bu alan false olarak gönderilirse, kendi eklemiş olduğunuz XLST / XSLT'ler içersinden default olana göre irsaliye getirilir.

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Get HTML

İrsaliyeyi Html formatında indirme.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

isStandartXslt
bool

Bu alan false olarak gönderilirse, kendi eklemiş olduğunuz XLST / XSLT'ler içersinden default olana göre irsaliye getirilir.

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Get ZİP

İrsaliyeyi Zip formatında indirme.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

isStandartXslt
bool

Bu alan false olarak gönderilirse, kendi eklemiş olduğunuz XLST / XSLT'ler içersinden default olana göre irsaliye getirilir.

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Giden e-İrsaliyelerinize Verilen Yanıt

Gönderdiğiniz e-İrsaliyelere verilen yanıtları görüntüleyebileceğiniz servis uç noktarlını içerir.

Get Receipt List

Gelen irsaliye yanıtlarını liste şeklinde, Json olarak dönen uç noktasıdır.

query Parameters
receiptNumber
string

Cevap numarası.

status
nullable int
Enum: "Taslak : 0" "Kuyrukta : 20" "Hata : 40" "GIB'e İletildi : 50" "Onaylandı : 60"

Cevabın Durumu.

startDate - (2019-10-30 00:00:00)
string

Çekmek istediğiniz irsaliye cevaplarının oluşturma tarine göre, başlangıç tarihidir.

endDate - (2019-11-30 00:00:00)
string

Çekmek istediğiniz irsaliye cevaplarının oluşturma tarine göre, son tarihidir. Bulunduğunuz gün ve saatten büyük değer olmamalıdır.

pageIndex
required
int

Çekmek istediğiniz başlangıç sayfasını belirtir.

pageSize
required
int

Çekmek istediğiniz sayfada kaç adet kayıt olması gerektiğini belirtir. Tek seferde max 500 kayıt

isDesc
bool

Çekmek istediğiniz sayfada kaç adet kayıt olması gerektiğini belirtir. Tek seferde max 500 kayıt

Responses

Response samples

Content type
application/json
{
  • "pageIndex": null,
  • "pageSize": null,
  • "totalCount": null,
  • "totalPages": null,
  • "hasNextPage": null,
  • "hasPreviousPage": null,
  • "items": {
    }
}

Get UBL

Gelen irsaliye yanıtının UBL'ini Zip olarak indiren uç noktasıdır.

path Parameters
id
Guid

Giden e-İrsaliyenin unique id'si

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Get PDF

Gelen irsaliye yanıtını Pdf olarak indirme.

path Parameters
id
Guid

Giden e-İrsaliyenin unique id'si

isStandartXslt
bool

Bu alan false olarak gönderilirse, kendi eklemiş olduğunuz XLST / XSLT'ler içersinden default olana göre irsaliye getirilir.

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Get HTML

Gelen irsaliye yanıtını Html formatında indirme.

path Parameters
id
Guid

Giden e-İrsaliyenin unique id'si

isStandartXslt
bool

Bu alan false olarak gönderilirse, kendi eklemiş olduğunuz XLST / XSLT'ler içersinden default olana göre irsaliye getirilir.

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Gelen e-İrsaliye

Gelen e-İrsaliyeleri listeliyebileceğiniz, ön izlemesini alabileceğiniz servis uç noktarını içerir.

Get Status

Gelen e-irsaliyenin durumunu sorgulayan uç noktasıdır.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "despatchNumber": "string",
  • "status": "Onaylandı : 60"
}

Get Despatch List

Gelen e-İrsaliye listesini çekmek için kullanılır.

query Parameters
despatchNumber
string

İrsaliye durumarası.

targetVknTckn
string

İrsaliyenin hedef VKN/TCKN'si.

status
nullable int
Enum: "Taslak : 0" "Kuyrukta : 20" "Hata : 40" "GIB'e İletildi : 50" "Onaylandı : 60" "Onaylanıyor : 61" "Onaylama Hatası : 62" "Otomatik Onaylama : 65" "Onay Bekliyor : 70" "Reddedildi : 80" "Reddediliyor : 81" "Reddetme Hatası : 82" "Kısmi Kabul Edildi : 90" "Kısmi Kabul Ediliyor : 91" "Kısmi Kabul Hatası : 92"

İrsaliyenin Durumu.

startDate - (2019-10-30 00:00:00)
string

Çekmek istediğiniz irsaliyelerin oluşturma tarine göre, başlangıç tarihidir.

endDate - (2019-11-30 00:00:00)
string

Çekmek istediğiniz irsaliyelerin oluşturma tarine göre, son tarihidir. Bulunduğunuz gün ve saatten büyük değer olmamalıdır.

pageIndex
required
int

Çekmek istediğiniz başlangıç sayfasını belirtir.

pageSize
required
int

Çekmek istediğiniz sayfada kaç adet kayıt olması gerektiğini belirtir. Tek seferde max 500 kayıt

isDesc
bool
Enum: "true : Evet" "false : Hayır"

Çekmek istediğiniz irsaliyeleri oluşturma tarihine göre sıralamak için gönderilir.

Responses

Response samples

Content type
application/json
{
  • "pageIndex": null,
  • "pageSize": null,
  • "totalCount": null,
  • "totalPages": null,
  • "hasNextPage": null,
  • "hasPreviousPage": null,
  • "items": {
    }
}

Get UBL

Gelen irsaliyenin UBL'ini Zip olarak indiren uç noktasıdır.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Get PDF

Gelen irsaliyeyi Pdf olarak indirme.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

isStandartXslt
bool

Bu alan false olarak gönderilirse, kendi eklemiş olduğunuz XLST / XSLT'ler içersinden default olana göre irsaliye getirilir.

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Get HTML

Gelen irsaliyeyi Html formatında indirme.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

isStandartXslt
bool

Bu alan false olarak gönderilirse, kendi eklemiş olduğunuz XLST / XSLT'ler içersinden default olana göre irsaliye getirilir.

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Gelen e-İrsaliyeye Verilen Yanıt

Sizlere gelen e-İrsaliyelere verilecek ve bu yanıtları görüntüleyecek servis uç noktalarını içerir.

Post ( UBL )

İrsaliyeyi UBL olarak hazırlayanların kullanabileceği uç noktasıdır. Hazırlanan xml, zip'lenerek modelde ilgili alana eklenerek gönderilir.

Request Body schema: application/json
ReceiptAdvice
string

Döneceğiniz yanıta ait XML'i, bytcode dönüştürmeniz gerekmektedir daha sonra bu bytcodu Base64 formatıyla stringe parse ederek bu alana koymalısınız.

Prefix
string

Giden cevap numarası için belirlenmesi gereken ön ektir.

UseManualReceiptAdviceId
bool

16 haneli irsaliye numarası UBL içerisinden gönderilirse 'true' olarak set edilmeli.

Status
int
Enum: "Taslak : 0" "Kaydet ve Gönder : 20"

İrsaliyenin durumunu belirtir. Taslak olarak gönderirseniz, gelen irsaliyenin statüsü, onay bekliyordan onaylanıyora döner.

Responses

Request samples

Content type
application/json
{
  • "ReceiptAdvice": "string",
  • "Prefix": "string",
  • "UseManualReceiptAdviceId": null,
  • "Status": "Taslak : 0"
}

Response samples

Content type
application/json
{
  • "id": null,
  • "receiptAdviceNumber": "string",
  • "status": null
}

Put ( UBL )

İrsaliyeyi UBL olarak hazırlayanların güncelleme için kullanabileceği uç noktasıdır. Post (UBL)'de olduğu gibi, zip'lenerek modelde ilgili alana eklenerek gönderilir.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

Request Body schema: application/json
ReceiptAdvice
string

Döneceğiniz yanıta ait XML'i, bytcode dönüştürmeniz gerekmektedir daha sonra bu bytcodu Base64 formatıyla stringe parse ederek bu alana koymalısınız.

Prefix
string

Giden cevap numarası için belirlenmesi gereken ön ektir.

UseManualReceiptAdviceId
bool

16 haneli irsaliye numarası UBL içerisinden gönderilirse 'true' olarak set edilmeli.

Status
int
Enum: "Taslak : 0" "Kaydet ve Gönder : 20"

İrsaliyenin durumunu belirtir. Taslak olarak gönderirseniz, gelen irsaliyenin statüsü, onay bekliyordan onaylanıyora döner.

Responses

Request samples

Content type
application/json
{
  • "ReceiptAdvice": "string",
  • "Prefix": "string",
  • "UseManualReceiptAdviceId": null,
  • "Status": "Taslak : 0"
}

Response samples

Content type
application/json
{
  • "id": null,
  • "receiptAdviceNumber": "string",
  • "status": null
}

Put Update Status List

Hatalı veya Taslak durumundaki irsaliye yanıtlarının statüsünü değiştirmek için kullanılır. Hatalı irsaliye yanıtını taslağa çekmek, taslaktaki irsaliye yanıtını kuyruğa eklemek için bu metot kullanılır.

Request Body schema: application/json
any

Ids:[ "dba1c5ea-0229-410a-8193-958ff76b7d19", "dba1c5ea-0229-410a-8193-958ff76b7d19"]

Status: Taslak: 0, Kuyrukla ve Gönder: 20

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
{
  • "Error": {
    }
}

Post Partial Accept

İrsaliyenin kısmı kabul işleminin gerçekleştirildiği uç noktasıdır.

Request Body schema: application/json
despatchAdviceUUID
required
Guid

Cevabı gönderilecek olan irsaliyenin unique Id'si

actualDeliveryDateTime
required
Datetime

Cevabı gönderilecek olan irsaliyenin teslim tarihi ve saati

deliveryContact
required
string

İrsaliye cevabını teslim alan

prefix
required
string

İrsaliye numarasının ön ekidir.

object

İrsaliye İçeriklerinin Bulunduğu Alan

Responses

Request samples

Content type
application/json
{
  • "despatchAdviceUUID": null,
  • "actualDeliveryDateTime": null,
  • "deliveryContact": "string",
  • "prefix": "string",
  • "items": {
    }
}

Response samples

Content type
application/json
{
  • "id": null,
  • "receiptAdviceNumber": "string",
  • "status": null
}

Get Status

Gelen e-irsaliyeye, oluşturulan yanıt irsaliyesinin durumunu sorgulayan uç noktasıdır. Gönderilen yanıtın durumuna göre envelope (zarf) bilgileri dönmemektedir. Modellerinizi bu hususa göre oluşturmalısınız.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

Responses

Response samples

Content type
application/json
{
  • "id": null,
  • "receiptNumber": "string",
  • "inboxDespatchNumber": "string",
  • "status": "Taslak : 0",
  • "message": "string",
  • "envelopeId": null,
  • "envelopeStatus": "Zarf kuyruğa Ekledi : 1000",
  • "envelopeMessage": null
}

Approve Reject Despatch

İrsaliyenin kabul / red işleminin gerçekleştirildiği uç noktasıdır.

query Parameters
ids
Guid

Erişilmek istenen kaynağın unique id'si

isApprove
bool
Enum: "true : kabul" "false : reddetme"

Kabul veya reddetme parametresidir.

prefix
string

Giden cevap numarası için belirlenmesi gereken ön ektir.

reason
Guid

Eğer red cevabı gönderiliyor ise reddin sebebi yazılmalıdır.

actualDeliveryDate
Datetime
Example: actualDeliveryDate=2019-12-30 00:00:00

Cevabı gönderilecek olan irsaliyenin teslim tarihi ve saati

Responses

Response samples

Content type
application/json
null

Get UBL

Gelen irsaliyeye karşılık verilen cevabın UBL'ini Zip olarak indiren uç noktasıdır.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Get UBL By InboxDespatch

Gelen e-İrsaliyenin Id bilgisini kullanarak, gelen e-İrsaliyeye vermiş olduğunuz yanıtın UBL 'ini zip olarak indiren servis uç noktasıdır.

path Parameters
id
Guid

Gelen e-İrsaliyenin unique id'si

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Get PDF

Gelen irsaliyeye karşılık verilen cevabın Pdf olarak indirme.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

isStandartXslt
bool

Bu alan false olarak gönderilirse, kendi eklemiş olduğunuz XLST / XSLT'ler içersinden default olana göre irsaliye getirilir.

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Get HTML

Gelen irsaliyeye karşılık verilen cevabın Html formatında indirme.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

isStandartXslt
bool

Bu alan false olarak gönderilirse, kendi eklemiş olduğunuz XLST / XSLT'ler içersinden default olana göre irsaliye getirilir.

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Get ZİP

Gelen irsaliyeye karşılık verilen cevabın Zip formatında indirme.

path Parameters
id
Guid

Erişilmek istenen kaynağın unique id'si

isStandartXslt
bool

Bu alan false olarak gönderilirse, kendi eklemiş olduğunuz XLST / XSLT'ler içersinden default olana göre irsaliye getirilir.

Responses

Response samples

Content type
application/json
{
  • "Response": { }
}

Mükellefler

e-İrsaliye mükellef listesi, gönderici/alıcı birim bilgileri

GibUserZipList

Zip içerisinde Json model döner.İçerisinde sadece e-irsaliye kullanıcılarının alıcı bilgileri(pk/alias) vardır.Model açıklamaları 200 response içindedir.

Responses

Response samples

Content type
application/json
null