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ürecinizdeki sorular için, destek@eplatform.com.tr adresinden iletişime geçebilirsiniz. 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.

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

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

Ö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. Geliştirilme aşamasındadı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.

addressBook
object

İrsaliye İçeriklerinin Bulunduğu Alan

generalInfoModel
object

İrsaliye İçeriklerinin Bulunduğu Alan

despatchLines
object

İrsaliye İçeriklerinin Bulunduğu Alan

deliveryAddressInfo
object

İrsaliye İçeriklerinin Bulunduğu Alan

despatchShipmentInfo
object

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

orderInfo
object

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

notes
string array

Not alandır. [ "not-1", "not-2"...]

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable entity

post /outboxdespatch/create

Live Server

https://eirsaliyeservice.turkcellesirket.com/v1/outboxdespatch/create

Test Server

https://eirsaliyeservicetest.isim360.com/v1/outboxdespatch/create

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "status": 20,
  • "isNew": true,
  • "localReferenceId": "string",
  • "useManualDespatchAdviceId": null,
  • "addressBook":
    {
    },
  • "generalInfoModel":
    {
    },
  • "despatchLines":
    {
    },
  • "deliveryAddressInfo":
    {
    },
  • "despatchShipmentInfo":
    {
    },
  • "orderInfo":
    {
    },
  • "notes": "[]"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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. Geliştirilme aşamasındadı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.

addressBook
object

İrsaliye İçeriklerinin Bulunduğu Alan

generalInfoModel
object

İrsaliye İçeriklerinin Bulunduğu Alan

despatchLines
object

İrsaliye İçeriklerinin Bulunduğu Alan

deliveryAddressInfo
object

İrsaliye İçeriklerinin Bulunduğu Alan

despatchShipmentInfo
object

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

orderInfo
object

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

notes
string array

Not alandır. [ "not-1", "not-2"...]

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable entity

put /outboxdespatch/update/{id}

Live Server

https://eirsaliyeservice.turkcellesirket.com/v1/outboxdespatch/update/{id}

Test Server

https://eirsaliyeservicetest.isim360.com/v1/outboxdespatch/update/{id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "status": 20,
  • "isNew": true,
  • "localReferenceId": "string",
  • "useManualDespatchAdviceId": null,
  • "addressBook":
    {
    },
  • "generalInfoModel":
    {
    },
  • "despatchLines":
    {
    },
  • "deliveryAddressInfo":
    {
    },
  • "despatchShipmentInfo":
    {
    },
  • "orderInfo":
    {
    },
  • "notes": "[]"
}

Response samples

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

Put Update Status

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.

query Parameters
id
Guid

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

status
any
Enum: {"Draft":0} {"Queued":20}

İrsaliyenin durumunu belirtir.

Responses

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable entity

put /outboxdespatch/updatestatus

Live Server

https://eirsaliyeservice.turkcellesirket.com/v1/outboxdespatch/updatestatus

Test Server

https://eirsaliyeservicetest.isim360.com/v1/outboxdespatch/updatestatus

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Id": null,
  • "DespatchNumber": null,
  • "ProfileId": 0,
  • "TypeCode": 1,
  • "TargetVKNTckn": null,
  • "TargetTitle": null,
  • "TargetAlias": null,
  • "Status": null,
  • "LocalReferanceId": null,
  • "Message": null,
  • "Currency": null,
  • "TotalAmount": null,
  • "CreatedDate": null,
  • "SentDate": null,
  • "IssueDate": null,
  • "ReceiptIsApproved": null,
  • "ReceiptUUID": null
}

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 ( Giden irsaliye olduğunda doldurulabilir, null gönderildiği taktirde default değer atanır.)

targetAlias
string

Hedef müşteri posta kutusu. Birden fazla PK adresi olan firmalara kesilecek irsaliyelerde, bu alanı doldurmanız gerekmektedir.

useManualDespatchAdviceId
bool

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

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

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable entity

post /outboxdespatch

Live Server

https://eirsaliyeservice.turkcellesirket.com/v1/outboxdespatch

Test Server

https://eirsaliyeservicetest.isim360.com/v1/outboxdespatch

Request samples

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

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "Id": "string",
  • "DespatchNumber": 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 ( Giden irsaliye olduğunda doldurulabilir, null gönderildiği taktirde default değer atanır.)

targetAlias
string

Hedef müşteri posta kutusu. Birden fazla PK adresi olan firmalara kesilecek irsaliyelerde, bu alanı doldurmanız gerekmektedir.

useManualDespatchAdviceId
bool

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

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

200
400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

Unprocessable entity

put /outboxdespatch/{id}

Live Server

https://eirsaliyeservice.turk