BASE_DOMAIN=https://shipapi.mysys.com (CANLI – PRODUCTION ortam)
BASE_DOMAIN=https://shipapitest.mysys.com (TEST ortam)
1. Depo listesi sorgulama:
Sisteme üye olan depoların listesinin alınması.
Example Request:
GET /warehouse/listHTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
Example Response:
[
{
“id”: “1”,
“name”: “UK PreFulfillment”,
“addressLine1”: “5 Viking Self Storage,”,
“addressLine2”: “5 Turnpike Close”,
“city”: “Norwich”,
“state”: null,
“postal”: “NR6 5BD”,
“countryCode”: “GB”,
“defaultCurrency”: “GBP”
},
{
“id”: “3”,
“name”: “SHIPPING GARAGE”,
“addressLine1”: “1663 S Mount Prospect Rd”,
“addressLine2”: “5 Turnpike Close”,
“city”: “Des Plaines”,
“state”: “ILLINOIS”,
“postal”: “60018”,
“countryCode”: “US”,
“defaultCurrency”: “USD”
}
]
2. Depo Ekstra Hizmet Listesi ve Fiyatları:
Deponun ekstra olarak verdiği hizmetler.
Example Request:
POST /servicePlanItems/listHTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
{
“warehouseId”: 1,
“userId”: 1515
}
}
Example Response:
[
{
“id”: 1232,
“name”: “Sticker Removal”,
“price”: 2.35,
“type”: “perproduct”,
},
{
“id”: 1233,
“name”: “Stretch Wrapping”,
“price”: 4.50,
“type”: “perpackage”,
},
…
]
3. Kullanıcı Yeni Üyelik:
Kullanıcıların sisteme üye yapılması.
Example Request:
POST /user/addUpdateHTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
{
“id”: null, // id verilirse update edilir
“email”: “test@test.com”, // update edilemez alan
“name”: “Halil”,
“lastname”: “YILMAZ”,
“phone”: “+90 542 232 23 22”,
“defaultWarehouseId”: null,
“isActive”: true // pasife çekmek için false verilir
}
Example Response:
{
“IsSuccess”: true,
“Id”: 1121,
“Error”: null
}
4. Kullanıcı Listesi:
Kullanıcı listesini verir.
Example Request:
GET /user/list?warehouseId=4 HTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
Example Response:
[
{
“Id”: 173,
“Email”: “email.test@asd.com”,
“Name”: “Halill”,
“LastName”: “YILMAZ”,
“Phone”: “0555554443333”,
“DefaultWarehouseId”: 4,
“IsActive”: false
}
]
5. Kullanıcı Bilgisi:
Kullanıcı bilgisini verir. (UserId ye göre)
Example Request:
GET /user/get?userId=173 HTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
Example Response:
{
“Id”: 173,
“Email”: “email.test@asd.com”,
“Name”: “Halill”,
“LastName”: “YILMAZ”,
“Phone”: “0555554443333”,
“DefaultWarehouseId”: 4,
“IsActive”: false
}
6. Kullanıcı Ürün Tanımlama:
Depoya gönderilecek olan ürünlerin sisteme tanımlanması.
Example Request:
POST /product/addUpdateHTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
{
“id”: null,
“warehouseId”: 4, // update edilemez
“userId”: 173, // update edilemez
“title”: “Drawing coloured pencils”,
“marketplaceId” : “A1F83G8C2ARO7P”, // amazon ürünlerinde
“ASIN”: “B01212112”, // amazon ürünlerinde
“SKU”: “SKU-1223324”,
“barcode”: “4444333223”,
“imageUrl”: “https://m.media-amazon.com/images/I/Ewocn_SL75_.jpg”,
“weight”: 1.2,
“weightUnit”: “kg”, // kg, lb
“height”: 12.10,
“width”: 8.50,
“length”: 14.50,
“dimensionUnit”: “cm”, // cm, in
“price”: 99.90,
“currency”: “GBP”, // USD, GBP, EUR (warehouse default currency)
“expirationDate”: “2021-08-21”,
“isActive”: true
}
Example Response:
{
“IsSuccess”: true,
“Id”: 312221,
“Error”: null
}
7. Kullanıcı Ürün Listesi:
Kullanıcıya tanımlanmış olan ürünlerin listesini verir.
Example Request:
GET /product/list?userId=173&warehouseId=4 HTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
Example Response:
[
{
“Id”: 66,
“WarehouseId”: 4,
“UserId”: 173,
“Title”: “Drawing coloured pencils”,
“MarketplaceId”: “A1F83G8C2ARO7P”,
“ASIN”: “B01212112”,
“SKU”: “SKU-1223324”,
“Barcode”: “4444333223”,
“ImageUrl”: “https://m.media-amazon.com/images/I/Ewocn_SL75_.jpg”,
“Weight”: 1.2,
“WeightUnit”: “kg”,
“Length”: 14.5,
“Width”: 8.5,
“Height”: 12.1,
“DimensionUnit”: “cm”,
“Price”: 99.9,
“Currency”: “GBP”,
“IsActive”: true
}
]
8. Ürün Bilgisi:
Ürün Id sine göre ürün bilgisini verir.
Example Request:
GET /product/get?productId=66 HTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
Example Response:
{
“Id”: 66,
“WarehouseId”: 4,
“UserId”: 173,
“Title”: “Drawing coloured pencils”,
“MarketplaceId”: “A1F83G8C2ARO7P”,
“ASIN”: “B01212112”,
“SKU”: “SKU-1223324”,
“Barcode”: “4444333223”,
“ImageUrl”: “https://m.media-amazon.com/images/I/Ewocn_SL75_.jpg”,
“Weight”: 1.2,
“WeightUnit”: “kg”,
“Length”: 14.5,
“Width”: 8.5,
“Height”: 12.1,
“DimensionUnit”: “cm”,
“Price”: 99.9,
“Currency”: “GBP”,
“IsActive”: true
}
9. Depoya Ürün Gönderme:
Ürünleri depoya göndermek için yeni sevkiyat oluşturma.
Example Request:
POST/fbm/addUpdateHTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
{
“id”: null,
“warehouseId”: 1,
“userId”: 1251,
“packages”: [
{
“carrierName”: “Fedex”,
“trackNumber”: “TK12312323233”,
“packageItems”:[
{
“productId”: 121234,
“quantity”: 10,
},
{
“productId”: 121235,
“quantity”: 20,
},
]
}
],
“isActive”: true
}
Example Response:
{
“IsSuccess”: true,
“Id”: 31223,
“Address”: “5 Viking Self Storage,5 Turnpike Close #1001 # INV 1001 Norwich NR6 5BDUnited Kingdom”,
“Error”: null
}
10. Depoya Ürün Gönderme İptal:
Depoya ürün gönderme işlemini iptali eder. (Sadece Status= NewShipment durumunda)
Example Request:
GET/fbm/cancel/{{fbmId}} HTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
Example Response:
{
“IsSuccess”: true,
“Id”: 122122,
“Error”: null
}
11. Kullanıcı Envanter Listesinin Alınması (Depo stok durumu):
Kullanıcıların depoya gönderdikleri ürünlerin listelerini sorgulanması.
Example Request:
POST/inventory/listHTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
{
“warehouseId”: 1,
“userId”: 1251,
}
Example Response:
[
{
“productId”: 1121,
“inventoryId”: 31223,
“section”: “KTX-12”,
“title”: “Pencil 3 pieces”,
“asin”: “B0121212”,
“sku”: “sku-123123”,
“barcode”: “121621726”,
“parcelType”: “Palett”,
“stock”: 12,
“inventoryStatus”: “ok”,
},
{
“productId”: 1121,
“inventoryId”: 31224,
“title”: “Pencil 3 pieces”,
“asin”: “B0121212”,
“sku”: “sku-123123”,
“barcode”: “121621726”,
“parcelType”: “Palett”,
“section”: “KTX-12”,
“stock”: 1,
“inventoryStatus”: “damaged”,
},
{
“productId”: 1123,
“inventoryId”: 31225,
“asin”: null,
“title”: “Erasers 3 pieces”,
“sku”: “sku-123123”,
“barcode”: null,
“parcelType”: “Box”,
“section”: “KTB-22”,
“stock”: 24,
“inventoryStatus”: “ok”,
},
]
12. Depo Çıkış Emri Oluşturma (stoktan gönderi oluşturma):
Kullanıcıların depodaki ürünlerinin depodan çıkışının yapılması. Ekstra hizmetler alınacaksa çıkış emrine girilecek.
Example Request:
POST/shipment/addHTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
{
“warehouseId”: 1,
“userId”: 1251,
“latestDeliveryDate”:”2021-10-23″,
“userNote”:”kullanıcı notu….”,
“products”: [
{
“inventoryId”: null,
“productId”: 67,
“quantity”: 2
},
{
“inventoryId”: 31224,
“productId”: 68,
“quantity”: 2
},
],
“extraServices”: [
{
“inventoryId”: null,
“productId”: 67,
“servicePlanItemId “: 1232,
},
{
“inventoryId”: null,
“productId”: 68,
“servicePlanItemId “: 1232
},
{
“inventoryId”: null,
“productId”: null,
“servicePlanItemId”: 1233
},
],
“shipTo”: {
“name”: “MichaelKors”,
“email”: “kors@gmail.com”,
“company”: “US Govt”,
“address1”: “1600 Pennsylvania Ave”,
“address2”: “Oval Office”,
“city”: “Washington”,
“state”: “DC”,
“postalCode”: “20500”,
“countryCode”: “US”,
“phone”: null
},
“labelPdf”: {{varsa base64 formatında string yoksa null geçilecek}},
}
Example Response:
{
“IsSuccess”: true,
“Id”: 122122, // ShipmentId
“ShipmentNumber”: “#PF 10023”,
“Status”: “NewShipment”,
“Error”: null
}
13. Depo Çıkış Emri Oluşturma (stoksuz gönderi oluşturma):
Kullanıcıların transit/dropship tarzı stokta olmayan ürünlerinin gönderilmesi. Ekstra hizmetler alınacaksa çıkış emrine girilecek.
Example Request:
POST/shipment/addHTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
{
“warehouseId”: 1,
“type”: [“nonstock”,”collection”] ,
“userId”: 1251,
“latestDeliveryDate”:”2021-10-23″,
“userNote”:”kullanıcı notu….”,
“products”: [
{
“inventoryId”: null,
“productId”: 67,
“quantity”: 2
},
{
“inventoryId”: 31224,
“productId”: 68,
“quantity”: 2
},
],
“extraServices”: [
{
“inventoryId”: null,
“productId”: 67,
“servicePlanItemId “: 1232,
},
{
“inventoryId”: null,
“productId”: 68,
“servicePlanItemId “: 1232
},
{
“inventoryId”: null,
“productId”: null,
“servicePlanItemId”: 1233
},
],
“shipTo”: {
“name”: “MichaelKors”,
“email”: “kors@gmail.com”,
“company”: “US Govt”,
“address1”: “1600 Pennsylvania Ave”,
“address2”: “Oval Office”,
“city”: “Washington”,
“state”: “DC”,
“postalCode”: “20500”,
“countryCode”: “US”,
“phone”: null
},
“labelPdf”: {{varsa base64 formatında string yoksa null geçilecek}},
}
Example Response:
{
“Type”: “nonstock”,
“CustomerNumber”: “1295”,
“SendToAddress”: {
“Name”: “UKprefulfillment”,
“Company”: “UKprefulfillment”,
“Phone”: “+44 7380427172”,
“Email”: “noreply@ukprefulfillment.com”,
“Address1”: “K Shed Warehouse,”,
“Address2”: “Zone 3i Longships Road”,
“City”: “Cardiff”,
“State”: “England”,
“Postal”: “CF10 4RP”,
“CountryCode”: “GB”,
“FullAddress”: “UKprefulfillment K Shed Warehouse, Zone 3i Longships Road #1295 #PF-10601 Cardiff England GB CF10 4RP”
},
“Description”:
“These products must first be sent to the warehouse. Please send the products to the specified address. (with the customer number and shipment number)”,
“IsSuccess”: true,
“Id”: 122122, // ShipmentId
“ShipmentNumber”: “#PF 10023”,
“Status”: “NewShipment”,
“Error”: null
}
14. Gönderi etiket güncelleme:
Collection olarak gönderilmiş gönderiye daha sonradan kullanıcı etiketinin yüklenebilmesi amacıyla eklenmiştir.
Example Request:
POST/shipment/update HTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
{
“id”: 1800, // shipment id
“labelPdf”: // base64 pdf, jpg, docs … “JVBERi0xLjcNCiWhs8XXDQoxIDAgb2JqDQo8PC9QYWdlcyAyIDAgUiAvVHlwZS9DYXRhbG9nPj4NCmVuZG9iag0KMiAwIG9iag0KPDwvQ291bnQgMjEvS2lkc1sgNCAwIFIgIDE1IDAgUiAgMTkgMCBSICAyMyAwIFIgIDI3IDAgUiAgMzEgMCBSICAzNSAwIFIgIDM5IDAgUiAgNDMgMCBSICA1MiAwIFIgIDU2IDAgUiAgNjEgMCBSICA2NSAwIFIgIDY5IDAgUiAgNzMgMCBSICA3NyAwIFIgIDgyIDAgUiAgODYgMCBSICA5MCAwIFIgIDk0IDAgUiAgOT…………………”
}
Example Response:
{
“IsSuccess”: true,
“Id”: 1800,
“Error”: null,
“Status”: null
}
15. Depo Çıkış Emri İptali:
Depo çıkış emrinin iptal edilmesi. Çıkış emirleri Status=InProcess durumuna kadar cancel edilebilir.
Example Request:
GET/shipment/cancel/{{shipmentId}} HTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
Example Response:
{
“IsSuccess”: true,
“Id”: 122122,
“Error”: null
}
16. Gönderi Bilgilerinin Alınması, Etiket bilgilerinin Alınması:
Gönderi durumlarının sorgulanması. Track no, label pdf bilgilerinin alınması.
Example Request:
POST/shipment/get HTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
{
“shipmentId”: 122122,
“labelPdf “: false,
}
Example Response:
{
“IsSuccess”: true,
“Id”: 122122,
“ShipmentNumber”: “#PF 10023”,
“Status”: “Sended”,
“CarrierName”: “Royal Mail”,
“CarrierServiceType”: “Royal Mail 1 st Class 24 Hours”,
“TrackNumber”: “TK121221827182”,
“TotalPrice”: 12.45,
“PriceDetails”: [
{
“Name”: “Shipment”,
“Price”: 4.45,
“Quantity”: 1
},
{
“Name”: “Sticker Removal “,
“Price”: 6.00,
“Quantity”: 2
},
{
“Name”: “Stretch Wrapping “,
“Price”: 4.00,
“Quantity”: 1
},
],
“LabelPdf”: {{varsa base64 formatında string e dönüştürülmüş pdf dosyası gönderilir}},
“Error”: null
}
17. Gönderi Durumunun Sorgulanması:
Gönderi durumlarının sorgulanması.
Example Request:
GET/shipment/getStatus/{{shipmentId}} HTTP/1.1
Host:BASE_DOMAIN
Authorization: __YOUR_AUTH_HERE__
Content-Type: application/json
Example Response:
{
“IsSuccess”: true,
“Id”: 122122,
“ShipmentNumber”: “#PF 10023”,
“Status”: “Sended”,
“CarrierName”: “Royal Mail”,
“CarrierServiceType”: “Royal Mail 1 st Class 24 Hours”,
“TrackNumber”: “TK121221827182”,
}
Açıklamalar:
- Ödemeler API kullanıcısının tanımlı hesabından otomatik çekilecektir.
- FBA in kendine ait süreçleri olduğu için api den yapılmayacaktır.
- Transit gönderiler (depoda stokta olmayan ürünlerin gönderilmesi) api de yapılmayacaktır.
- Aylık depo barındırma ücretleri API kullanıcısının tanımlı hesaplarından otomatik çekilecektir. (api de bulunmayacaktır)
- Ürünlerin nihai kargo fiyatı deponun belirlediği kargo firmasına göre belirlenecektir.