GitHub

Shipments

A Shipment is an order that has been shipped.


Shipment resource

Shipment properties

idstringreadonly
customerstringreadonly
created_atstringreadonly
order_external_referencestring
shipment_external_referencestring
referencestring

GET Collection

Retrieves a collection of shipments.

Query parameters

limitint

Limits the amount of results

pageint

Only works in combination with limit

fromstring

Accepts date format %Y-%m-%d. IE: 2022-10-22

tostring

Accepts date format %Y-%m-%d. IE: 2022-10-22

directionstring

asc | desc

Example

1curl --location --request GET 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/shipments'

Response

1[
2 {
3 "id": "9bfcf441-b32a-4093-b5d7-6c64cef384a7",
4 "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
5 "created_at": "2022-03-08T11:46:44+00:00",
6 "order_external_reference": "perf_639068750747",
7 "shipment_external_reference": "EWHS-perf_639068750747",
8 "reference": "SHP00000000001"
9 },
10 {
11 "id": "66606c93-edc7-45b6-a400-f5fee5729e9f",
12 "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
13 "created_at": "2022-07-18T09:55:39+00:00",
14 "order_external_reference": "TEST_HENNY_003",
15 "shipment_external_reference": "EWHS-TEST_HENNY_003",
16 "reference": "SHP00000000064"
17 }
18]

GET Single

Retrieves a single shipment.

1curl --location --request GET 'https://eu-dev.middleware.ewarehousing-solutions.com/wms/shipments/9b247be6-fc99-47e7-a9f8-b2421c96b715'

Response

1{
2 "id": "c27f2a12-fcc5-4bf7-9b40-537c96f1bbd5",
3 "customer": "53b5a543-129a-403c-9a6e-3d9c525ffa5b",
4 "created_at": "2022-02-11T14:12:59+00:00",
5 "order_external_reference": "MW_ORD_001",
6 "shipment_external_reference": null,
7 "reference": "SHP00000000001",
8 "shipping_method": {
9 "id": "7e808ac8-4167-11e9-92f0-0242ac140006",
10 "shipper": "eWarehousing",
11 "shipper_code": "ewarehousing",
12 "code": "EWH_PICK_UP",
13 "description": "eWarehousing afhaal order",
14 "shipping_software": "ewh"
15 },
16 "shipment_labels": [
17 {
18 "label_code": "ewarehousing-afhaal-order",
19 "tracking_code": "ewh-pick-up",
20 "tracking_url": "#"
21 }
22 ],
23 "shipment_lines": [
24 {
25 "shipped_quantity": 1,
26 "shipped_ean": "978020137962",
27 "shipped_article_code": "VBP_A",
28 "shipped_sku": "VBP_A",
29 "serial_numbers": [],
30 "variant": {
31 "id": "f2894c16-399e-4ca1-9151-489775a6519c",
32 "article_code": "VBP_A",
33 "name": "Voorbeeld product - A",
34 "description": "Voorbeeld product - A",
35 "ean": "978020137962",
36 "sku": "VBP_A",
37 "hs_tariff_code": null,
38 "height": 2,
39 "depth": 3,
40 "width": 1,
41 "weight": 0,
42 "expirable": false,
43 "country_of_origin": null,
44 "using_serial_numbers": false,
45 "value": 15.95
46 }
47 }
48 ],
49 "shipping_address": {
50 "addressed_to": "Henny Krijnen",
51 "contact_person": null,
52 "street": "Nijverheidsweg",
53 "street2": null,
54 "street_number": "27",
55 "street_number_addition": null,
56 "zipcode": "3274 KJ",
57 "city": "Heinenoord",
58 "country": "NL",
59 "state": "Zuid holland",
60 "phone_number": null,
61 "mobile_number": "+31653282548",
62 "fax_number": null,
63 "email_address": null
64 }
65}