Shipping methods

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

The shipping method model

Properties

  • Name
    id
    Type
    string
    Readonly
    readonly
    Description
  • Name
    shipper
    Type
    string
    Description

    The fulfillment party such as DHL, dpd and PostNL.

  • Name
    shipper_code
    Type
    string
    Description

    The unique fulfillment party code.

  • Name
    shipping_software
    Type
    string
    Description

    The used shipping software such as Paazl and Sendcloud

  • Name
    created_at
    Type
    datetime
    Readonly
    readonly
    Description
  • Name
    modified_at
    Type
    datetime
    Readonly
    readonly
    Description
GET/wms/shippingmethods/

List all shipping methods

Retrieves a collection of shipping methods

Optional attributes

  • Name
    code
    Type
    string
    Description

    Code of the shipping method IE: INTERNATIONAL_ECONOMY

  • Name
    shipper
    Type
    string
    Description

    Name of the distributor IE: PostNL

  • Name
    shipper_code
    Type
    string
    Description

    Code of the shipper IE: postnl

  • Name
    shipping_software
    Type
    string
    Description

    Name of delivery platform IE: woflpack, sendcloud, paazl, etc...

  • 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:
    • createdAt
    • code

Request

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

Response

[
{
    "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"
}
]
GET/wms/shippingmethods/:id/

Retrieve a single shipping method

Retrieve a single shipping method

Request

GET
/wms/shippingmethods/:id/
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

{
    "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"
}