Shipments

A Shipment is an order that has been shipped.

The shipment model

Properties

Name
id
Type
string
Readonly
readonly
Description
Name
customer
Type
uuid
Description
Name
reference
Type
string
Description
Name
po_number
Type
string
Description
Name
order_external_reference
Type
array
Description
It's possible to fetch multiple shipments by providing multiple order external references.
Name
shipment_external_reference
Type
string
Description
Name
created_at
Type
datetime
Readonly
readonly
Description
Name
modified_at
Type
datetime
Readonly
readonly
Description

GET/wms/shipments/

List all shipments

Retrieves a collection of shipments

Optional attributes

Name
order_external_reference
Type
string
Description
Search for a specific order external reference.
Name
limit
Type
integer
Description
Limits the amount of results.
Name
page
Type
integer
Description
Only works in combination with the limit attribute.
Name
from
Type
date
Description
Accepts date format %Y-%m-%d. IE: 2022-10-22
Name
to
Type
date
Description
Accepts date format %Y-%m-%d. IE: 2022-10-22
Name
direction
Type
string
Description
Sort direction. Options: asc | desc
Default
Default: desc
Name
sort
Type
string
Description
You can sort on the following fields:
- reference
- createdAt
Default
Default: reference

Request

GET

/wms/shipments/

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/shipments/

Response

[
{
    "id": "9bfcf441-b32a-4093-b5d7-6c64cef384a7",
    "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
    "created_at": "2022-03-08T11:46:44+00:00",
    "order_external_reference": "perf_639068750747",
    "shipment_external_reference": "EWHS-perf_639068750747",
    "reference": "SHP00000000001",
    "po_number": null
},
{
    "id": "66606c93-edc7-45b6-a400-f5fee5729e9f",
    "customer": "be62c27e-2aac-4ac1-902e-f770d64f8dce",
    "created_at": "2022-07-18T09:55:39+00:00",
    "order_external_reference": "TEST_HENNY_003",
    "shipment_external_reference": "EWHS-TEST_HENNY_003",
    "reference": "SHP00000000064",
    "po_number": null
}
]

GET/wms/shipments/:id/

Retrieve a shipment

Retrieve a single shipment.

Request

GET

/wms/shipments/:id/

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/shipments/e710389a-5505-49d4-9b99-8314f3543427 \
-H 'Expand: shipment_lines,shipment_labels,shipping_address,shipping_method,serial_numbers,variant,administration_code'

Response

{
    "id": "c27f2a12-fcc5-4bf7-9b40-537c96f1bbd5",
    "customer": "53b5a543-129a-403c-9a6e-3d9c525ffa5b",
    "created_at": "2022-02-11T14:12:59+00:00",
    "order_external_reference": "MW_ORD_001",
    "shipment_external_reference": null,
    "reference": "SHP00000000001",
    "po_number": null,
    "shipping_method": {
        "id": "7e808ac8-4167-11e9-92f0-0242ac140006",
        "shipper": "eWarehousing",
        "shipper_code": "ewarehousing",
        "code": "EWH_PICK_UP",
        "description": "eWarehousing afhaal order",
        "shipping_software": "ewh",
        "administration_code": "123"
    },
    "shipment_labels": [
        {
            "label_code": "ewarehousing-afhaal-order",
            "tracking_code": "ewh-pick-up",
            "tracking_url": "#"
        }
    ],
    "shipment_lines": [
        {
            "shipped_quantity": 1,
            "shipped_ean": "978020137962",
            "shipped_article_code": "VBP_A",
            "shipped_sku": "VBP_A",
            "serial_numbers": [],
            "variant": {
                "id": "f2894c16-399e-4ca1-9151-489775a6519c",
                "article_code": "VBP_A",
                "name": "Voorbeeld product - A",
                "description": "Voorbeeld product - A",
                "ean": "978020137962",
                "sku": "VBP_A",
                "hs_tariff_code": null,
                "height": 2,
                "depth": 3,
                "width": 1,
                "weight": 0,
                "expirable": false,
                "country_of_origin": null,
                "using_serial_numbers": false,
                "value": 15.95
            }
        }
    ],
    "shipping_address": {
        "addressed_to": "Henny Krijnen",
        "contact_person": null,
        "street": "Nijverheidsweg",
        "street2": null,
        "street_number": "27",
        "street_number_addition": null,
        "zipcode": "3274 KJ",
        "city": "Heinenoord",
        "country": "NL",
        "state": "Zuid holland",
        "phone_number": null,
        "mobile_number": "+31653282548",
        "fax_number": null,
        "email_address": null
    }
}