İçeriğe geç
Store API

Shipment

Serverhttps://magaza-adiniz.myideasoft.com

Shipment LIST

GET
https://magaza-adiniz.myideasoft.com
/api/shipments
Bearer

Shipment LIST › query Parameters

sort
​string

Sıralama değeri. Örnek: Artan sıra için sort=id, azalan sıra için sort=-id

limit
​integer · min: 1 · max: 100

Bir sayfada gelecek Shipment Preferences adedi

Default: 20
page
​integer · min: 1

Hangi sayfadan başlanacağı

Default: 1
sinceId
​integer · min: 1

Yalnızca belirtilen id değerinden sonraki kayıtları getirir

ids
​string

Çoklu listeleme için virgülle ayrılmış id değerleri. ids=1,2,3,4

code
​string

Shipment code

invoiceKey
​string

Shipment invoice key

barcode
​string

Shipment barcode

order
​integer · min: 1

Order Id

startDate
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

Start of the time frame

endDate
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

End of the time frame

startUpdatedAt
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

Start of the time frame

endUpdatedAt
​string · date-time · pattern: yyyy-mm-dd hh:mm:ss

End of the time frame

Shipment LIST › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer

Teslimat nesnesi kimlik değeri.

Example: 123
barcode
​string · maxLength: 255

Teslimat barkodu.

Example: 12345678ASD
waybillNo
​string · maxLength: 255

Teslimat fatura numarası.

Example: A-1002
invoiceKey
​string · maxLength: 255

Teslimat irsaliye makbuzu numarası.

Example: A-1231
cargoOffice
​string · maxLength: 255

Teslimatın kargo şubesi

Example: Üsküdar
code
​string · maxLength: 255

Teslimat kodu. Kargo takip kodu.

Example: KOD123456
deliveryType
​string · maxLength: 255

Teslimat tipi

Example: deliveryType
invoiceIncluded
​integer · enum

Faturanın pakete dahillik durumunu belirtir.

Enum values:
0
1
Example: 1
payAtDoorAmount
​number · float · min: 0

Kapıda ödeme hizmeti bedeli.

Example: 5
createdAt
​string · date-time

Teslimat nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
status
​integer · enum

Teslimat nesnesinin aktiflik durumunu belirten değer.

Enum values:
0
1
-1
Example: 1
barcodeImage
​string

Barkod resmi.

trackingUrl
​string · maxLength: 255

Takip linki.


Shipment POST

POST
https://magaza-adiniz.myideasoft.com
/api/shipments
Bearer

Shipment POST › Request Body

id
​integer

Teslimat nesnesi kimlik değeri.

Example: 123
barcode
​string · maxLength: 255

Teslimat barkodu.

Example: 12345678ASD
waybillNo
​string · maxLength: 255

Teslimat fatura numarası.

Example: A-1002
invoiceKey
​string · maxLength: 255

Teslimat irsaliye makbuzu numarası.

Example: A-1231
cargoOffice
​string · maxLength: 255

Teslimatın kargo şubesi

Example: Üsküdar
code
​string · maxLength: 255

Teslimat kodu. Kargo takip kodu.

Example: KOD123456
deliveryType
​string · maxLength: 255

Teslimat tipi

Example: deliveryType
invoiceIncluded
​integer · enum

Faturanın pakete dahillik durumunu belirtir.

Enum values:
0
1
Example: 1
payAtDoorAmount
​number · float · min: 0

Kapıda ödeme hizmeti bedeli.

Example: 5
createdAt
​string · date-time

Teslimat nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
status
​integer · enum

Teslimat nesnesinin aktiflik durumunu belirten değer.

Enum values:
0
1
-1
Example: 1
barcodeImage
​string

Barkod resmi.

trackingUrl
​string · maxLength: 255

Takip linki.

Shipment POST › Responses

Oluşturma işlemi (POST) başarı ile sonuçlandı.

id
​integer

Teslimat nesnesi kimlik değeri.

Example: 123
barcode
​string · maxLength: 255

Teslimat barkodu.

Example: 12345678ASD
waybillNo
​string · maxLength: 255

Teslimat fatura numarası.

Example: A-1002
invoiceKey
​string · maxLength: 255

Teslimat irsaliye makbuzu numarası.

Example: A-1231
cargoOffice
​string · maxLength: 255

Teslimatın kargo şubesi

Example: Üsküdar
code
​string · maxLength: 255

Teslimat kodu. Kargo takip kodu.

Example: KOD123456
deliveryType
​string · maxLength: 255

Teslimat tipi

Example: deliveryType
invoiceIncluded
​integer · enum

Faturanın pakete dahillik durumunu belirtir.

Enum values:
0
1
Example: 1
payAtDoorAmount
​number · float · min: 0

Kapıda ödeme hizmeti bedeli.

Example: 5
createdAt
​string · date-time

Teslimat nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
status
​integer · enum

Teslimat nesnesinin aktiflik durumunu belirten değer.

Enum values:
0
1
-1
Example: 1
barcodeImage
​string

Barkod resmi.

trackingUrl
​string · maxLength: 255

Takip linki.


Shipment GET

GET
https://magaza-adiniz.myideasoft.com
/api/shipments/{id}
Bearer

Shipment GET › path Parameters

id
​string · pattern: \d+ · required

Shipment GET › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer

Teslimat nesnesi kimlik değeri.

Example: 123
barcode
​string · maxLength: 255

Teslimat barkodu.

Example: 12345678ASD
waybillNo
​string · maxLength: 255

Teslimat fatura numarası.

Example: A-1002
invoiceKey
​string · maxLength: 255

Teslimat irsaliye makbuzu numarası.

Example: A-1231
cargoOffice
​string · maxLength: 255

Teslimatın kargo şubesi

Example: Üsküdar
code
​string · maxLength: 255

Teslimat kodu. Kargo takip kodu.

Example: KOD123456
deliveryType
​string · maxLength: 255

Teslimat tipi

Example: deliveryType
invoiceIncluded
​integer · enum

Faturanın pakete dahillik durumunu belirtir.

Enum values:
0
1
Example: 1
payAtDoorAmount
​number · float · min: 0

Kapıda ödeme hizmeti bedeli.

Example: 5
createdAt
​string · date-time

Teslimat nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
status
​integer · enum

Teslimat nesnesinin aktiflik durumunu belirten değer.

Enum values:
0
1
-1
Example: 1
barcodeImage
​string

Barkod resmi.

trackingUrl
​string · maxLength: 255

Takip linki.


Shipment PUT

PUT
https://magaza-adiniz.myideasoft.com
/api/shipments/{id}
Bearer

Shipment PUT › path Parameters

id
​string · pattern: \d+ · required

Shipment PUT › Request Body

id
​integer

Teslimat nesnesi kimlik değeri.

Example: 123
barcode
​string · maxLength: 255

Teslimat barkodu.

Example: 12345678ASD
waybillNo
​string · maxLength: 255

Teslimat fatura numarası.

Example: A-1002
invoiceKey
​string · maxLength: 255

Teslimat irsaliye makbuzu numarası.

Example: A-1231
cargoOffice
​string · maxLength: 255

Teslimatın kargo şubesi

Example: Üsküdar
code
​string · maxLength: 255

Teslimat kodu. Kargo takip kodu.

Example: KOD123456
deliveryType
​string · maxLength: 255

Teslimat tipi

Example: deliveryType
invoiceIncluded
​integer · enum

Faturanın pakete dahillik durumunu belirtir.

Enum values:
0
1
Example: 1
payAtDoorAmount
​number · float · min: 0

Kapıda ödeme hizmeti bedeli.

Example: 5
createdAt
​string · date-time

Teslimat nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
status
​integer · enum

Teslimat nesnesinin aktiflik durumunu belirten değer.

Enum values:
0
1
-1
Example: 1
barcodeImage
​string

Barkod resmi.

trackingUrl
​string · maxLength: 255

Takip linki.

Shipment PUT › Responses

İşlem (GET veya PUT) başarı ile sonuçlandı.

id
​integer

Teslimat nesnesi kimlik değeri.

Example: 123
barcode
​string · maxLength: 255

Teslimat barkodu.

Example: 12345678ASD
waybillNo
​string · maxLength: 255

Teslimat fatura numarası.

Example: A-1002
invoiceKey
​string · maxLength: 255

Teslimat irsaliye makbuzu numarası.

Example: A-1231
cargoOffice
​string · maxLength: 255

Teslimatın kargo şubesi

Example: Üsküdar
code
​string · maxLength: 255

Teslimat kodu. Kargo takip kodu.

Example: KOD123456
deliveryType
​string · maxLength: 255

Teslimat tipi

Example: deliveryType
invoiceIncluded
​integer · enum

Faturanın pakete dahillik durumunu belirtir.

Enum values:
0
1
Example: 1
payAtDoorAmount
​number · float · min: 0

Kapıda ödeme hizmeti bedeli.

Example: 5
createdAt
​string · date-time

Teslimat nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300
status
​integer · enum

Teslimat nesnesinin aktiflik durumunu belirten değer.

Enum values:
0
1
-1
Example: 1
barcodeImage
​string

Barkod resmi.

trackingUrl
​string · maxLength: 255

Takip linki.


Shipment DELETE

DELETE
https://magaza-adiniz.myideasoft.com
/api/shipments/{id}
Bearer

Shipment DELETE › path Parameters

id
​string · pattern: \d+ · required

Shipment DELETE › Responses

Silme isteği başarı ile sonuçlandı. (cevapta içerik bulunmaz.)

No data returned