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.

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,
  • "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.

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