İçeriğe geç
Admin API

Shipment

Serverhttps://magaza-adiniz.myideasoft.com

Shipment LIST

GET
https://magaza-adiniz.myideasoft.com
/admin-api/shipments
Bearer
or
OAuth 2.0

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
id
​integer · min: 1

Tekli listeleme için id değeri

ids
​string

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

order
​integer · min: 1

Order Id

sinceId
​integer · min: 1

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

q
​string

Shipment Preferences arama filtresi. Kullanımı: q[<geçerli-query-parametresi>]

Shipment LIST › Responses

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

id
​integer · required

Teslimat nesnesi kimlik değeri.

Example: 123
status
​integer · enum · required

Teslimat nesnesinin aktiflik durumunu belirten değer.

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

Barkod resmi.

trackingUrl
​string · required

Takip linki.

barcode
​string

Teslimat barkodu.

Example: 12345678ASD
waybillNo
​string

Teslimat fatura numarası.

Example: A-1002
invoiceKey
​string

Teslimat irsaliye makbuzu numarası.

Example: A-1231
cargoOffice
​string

Teslimatın kargo şubesi

Example: Üsküdar
code
​string

Teslimat kodu. Kargo takip kodu.

Example: KOD123456
deliveryType
​string

Teslimat tipi

Example: deliveryType
invoiceIncluded
​string · enum

Faturanın pakete dahillik durumunu belirtir.

Enum values:
0
1
Example: 1
payAtDoorAmount
​string · min: 0

Kapıda ödeme hizmeti bedeli.

Example: 5
​OrderSummary

Sipariş detay objesi

createdAt
​string · date-time · writeOnly

Teslimat nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300

Shipment GET

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

Shipment GET › path Parameters

id
​string · pattern: \d+ · required

Shipment GET › Responses

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

id
​integer · required

Teslimat nesnesi kimlik değeri.

Example: 123
status
​integer · enum · required

Teslimat nesnesinin aktiflik durumunu belirten değer.

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

Barkod resmi.

trackingUrl
​string · required

Takip linki.

barcode
​string

Teslimat barkodu.

Example: 12345678ASD
waybillNo
​string

Teslimat fatura numarası.

Example: A-1002
invoiceKey
​string

Teslimat irsaliye makbuzu numarası.

Example: A-1231
cargoOffice
​string

Teslimatın kargo şubesi

Example: Üsküdar
code
​string

Teslimat kodu. Kargo takip kodu.

Example: KOD123456
deliveryType
​string

Teslimat tipi

Example: deliveryType
invoiceIncluded
​string · enum

Faturanın pakete dahillik durumunu belirtir.

Enum values:
0
1
Example: 1
payAtDoorAmount
​string · min: 0

Kapıda ödeme hizmeti bedeli.

Example: 5
​OrderSummary

Sipariş detay objesi

createdAt
​string · date-time · writeOnly

Teslimat nesnesinin oluşturulma zamanı.

Example: 2018-02-21T09:36:03+0300

Shipment CreateAction PUT

PUT
https://magaza-adiniz.myideasoft.com
/admin-api/shipments/create/{type}
Bearer
or
OAuth 2.0

Shipment CreateAction PUT › path Parameters

type
​string · pattern: \w+ · required

Shipment CreateAction PUT › Responses

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

No data returned

Shipment GenerateTrackingCodeAction PUT

PUT
https://magaza-adiniz.myideasoft.com
/admin-api/shipments/generate-tracking-code/{type}
Bearer
or
OAuth 2.0

Shipment GenerateTrackingCodeAction PUT › path Parameters

type
​string · pattern: \w+ · required

Shipment GenerateTrackingCodeAction PUT › Responses

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

No data returned

Shipment CancelAction PUT

PUT
https://magaza-adiniz.myideasoft.com
/admin-api/shipments/cancel/{type}
Bearer
or
OAuth 2.0

Shipment CancelAction PUT › path Parameters

type
​string · pattern: \w+ · required

Shipment CancelAction PUT › Responses

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

No data returned

Shipment PrintShippingAction GET

GET
https://magaza-adiniz.myideasoft.com
/admin-api/shipments/print_shipping/{id}
Bearer
or
OAuth 2.0

Shipment PrintShippingAction GET › path Parameters

id
​string · required

Shipment PrintShippingAction GET › Responses

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

No data returned