Get shipment¶
Order API v1
GET
*base*/shipments/*shipmentId*
Authentication:API key
Will list the shipment with the corresponding shipment Id.
Parameters¶
int
optional
|
Return shipment for a specific order. |
boolean
optional
|
Response in xml format instead of json. |
string
optional
|
Default value: goodtogo. Allowed values: inprogress, goodtogo, completed |
date
optional
|
Only return shipment newer than provided date |
date
optional
|
Only return shipment older than provided date |
Request example¶
1 | GET <base>/shipment/1234 HTTP/1.1
|
Response¶
200
Content-type: application/json
string
required
|
ok if success, else no . |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
array
required
|
Array of shipments returned, will only be one returned if found.
|
Response example¶
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 | HTTP/1.1 200 OK
Content-type: application/json
{
"status": "ok",
"shipments": [
{
"orderId": "83651",
"selectionId": "ff805e6dc70f905553e2225c6977a27a",
"orderDate": "2012-02-04 15:16:13",
"cancelDate": "2012-08-04 15:16:13",
"preferredDeliveryDate": "2012-05-04 15:16:13",
"estimatedDeliveryDate": "2012-05-04 15:16:13",
"orderStore": "retail",
"orderCurrency": "EUR",
"shipmentId": "83651-1",
"customerId": "11627",
"accountId": "0",
"billingName": "Someones Name",
"billingCompany": "",
"billingAddress": "Examplestreet 1",
"billingCoaddress": "",
"billingCity": "Somecity",
"billingState": "",
"billingZipcode": "12345",
"billingCountry": "DE",
"billingEmail": "someone@example.com",
"billingTele": "",
"deliveryName": "Someones Name",
"deliveryCompany": "",
"deliveryEmail": "someone@example.com",
"deliveryCell": "+4912345678",
"deliveryTele": "",
"deliveryAddress": "Examplestreet 1",
"deliveryCoaddress": "",
"deliveryZipcode": "12345",
"deliveryCity": "Somecity",
"deliveryState": "",
"deliveryCountry": "DE",
"billingVAT": "",
"poNumber": "",
"shippingList": "standard",
"shippingTerms": {
"id": 5,
"name": "ShippingTermName",
"description": "ShippingTermDescription"
},
"paymentTerms": {
"id": 10,
"name": "PaymentTermName",
"description": "PaymentTermDescription"
},
"proforma": "http://.../proforma?shipment=83651-1",
"deliveryNote": "http://../delnote?shipment=83651-1",
"defaultCarrier": "Delivery Carrier",
"deliveryService": "Delivery Service",
"shipmentDate": "2019-07-01 12:56:00",
"trackingNumber": "123456789",
"trackingUrl": "https://www.dhl.com.pl/exp-en/express/tracking.html?AWB=123456789",
"returnSlipTracking": "123456789",
"invoices": [
"https://online.klarna.com/invoice_public_show.yaws/invoice.pdf?invno=&orgno="
],
"suspect": 0,
"hold": 0,
"paid": 1,
"shouldCapture": 0,
"shippingValue": 25,
"voucherValue": 0,
"grandTotalValue": 3978.75,
"grandTotalTaxValue": 795.75,
"taxAdded": 0,
"taxDeducted": 0,
"internalComment": "",
"otherComment": "",
"taxBreakdown": [
{
"description": "VAT",
"taxPercent": 25,
"value": 795.75
}
],
"products": [
{
"lineId": "43243",
"sku": "S123K456U1",
"variantSku": "",
"sizeSku": "",
"name": "Product #1",
"variant": "White",
"size": "XS",
"ean": "1234567890123",
"qty": 1,
"originalPrice": 500.5,
"price": 450.5,
"weight": 2,
"weightUnit": "kg",
"countryOfOrigin": "DE",
"harmCode": "12345",
"comment": "",
"warehouses": [
{
"name": "Default warehouse",
"itemQty": "1"
}
],
"isBundle": false,
"isPartOfBundle": "217"
},
{
"lineId": "43244",
"sku": "S123K456U2",
"variantSku": "",
"sizeSku": "",
"name": "Product #2",
"variant": "Blue",
"size": "XS",
"ean": "1234567890124",
"qty": 2,
"originalPrice": 200.5,
"price": 180.5,
"weight": 1.5,
"weightUnit": "kg",
"countryOfOrigin": "CI",
"harmCode": "12345",
"comment": "",
"isBundle": true,
"bundle": [
{
"lineId": "43243",
"sku": "S123K456U1",
"variantSku": "",
"sizeSku": "",
"name": "Product #1",
"variant": "White",
"size": "XS",
"ean": "1234567890123",
"qty": 1,
"originalPrice": 500.5,
"price": 450.5,
"weight": 2,
"weightUnit": "kg",
"countryOfOrigin": "DE",
"harmCode": "12345",
"comment": "",
"warehouses": [
{
"name": "Default warehouse",
"itemQty": "1"
}
],
"isBundle": false,
"isPartOfBundle": "217"
},
]
}
]
}
]
}
|