Developer documentation

Shipping methods

Use the Shipping Methods API to list and retrieve shipping methods, including shipper, codes, and shipping software details.

A shipping method is used to specify what shipping party / option the order should be fulfilled with.

Response models

These response models describe the objects returned by this resource.

The shipping method model

Field	Description
`id` stringOptional	Read-only.
`shipper` stringOptional	The fulfillment party such as DHL, dpd and PostNL.
`shipper_code` stringOptional	The unique fulfillment party code.
`shipping_software` stringOptional	The used shipping software such as Paazl and Sendcloud
`created_at` datetimeOptional	Read-only.

List all shipping methods

GET/wms/shippingmethods/

Retrieves a collection of shipping methods

New to the Expand header? See how it works, available groups, and request examples: Expanding responses.

Try it

Send a live request against the development middleware using your current API test session.

GET

Request attributes

Field	Description
`code` stringOptional	Code of the shipping method IE: INTERNATIONAL_ECONOMY
`shipper` stringOptional	Name of the distributor IE: PostNL
`shipper_code` stringOptional	Code of the shipper IE: postnl
`shipping_software` stringOptional	Name of delivery platform IE: wolfpack, sendcloud, paazl, etc...
`limit` integerOptional	Limit the number of results. Default is 50.
`page` integerOptional	The page number to retrieve.
`direction` stringOptional	Sort direction. Options: `asc` or `desc`. Default is `desc`.
`sort` stringOptional	Sort field. Options: `createdAt` or `code`.

Request examplecURL

curl https://eu-dev.middleware.ewarehousing-solutions.com/wms/shippingmethods/ \
            -H 'Expand: administration_code'

Response exampleJSON

[
  {
    "id": "d94770bc-b236-49ec-8e31-88af42f2c282",
    "shipper": "eWarehousing Solutions",
    "shipper_code": "ewarehousing-solutions",
    "code": "delivery-by-doabuy-over-20kg",
    "description": "delivery-by-doabuy-over-20kg",
    "shipping_software": "ewh",
    "administration_code": "123"
  },
  {
    "id": "a299249a-b2cd-4666-a6e5-77d3e1156a22",
    "shipper": "eWarehousing Solutions",
    "shipper_code": "ewarehousing-solutions",
    "code": "EWH_PICK_UP",
    "description": "eWarehousing Solutions pickup order",
    "shipping_software": "ewh",
    "administration_code": "321"
  }
]

Retrieve a single shipping method

GET/wms/shippingmethods/:id/

Retrieve a single shipping method

Try it

Send a live request against the development middleware using your current API test session.

GET

Path parameters

Request examplecURL

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

Response exampleJSON

{
  "id": "a299249a-b2cd-4666-a6e5-77d3e1156a22",
  "shipper": "eWarehousing Solutions",
  "shipper_code": "ewarehousing-solutions",
  "code": "EWH_PICK_UP",
  "description": "eWarehousing Solutions pickup order",
  "shipping_software": "ewh"
}