GET /api/v1/shipment/shipments

Get a list of all shipments optionally filtered by date. All parameters are optional.

Servers

Query parameters

Name Type Required Description
page Integer No

Specifies the page to request.

createdAtMax String No

Specifies the newest shipment date to include in the response

createdAtMin String No

Specifies the oldest shipment date to include in the response

orderId Integer No

Get shipments for this order only.

shippingProviderId Integer No

Get Shippings for the specified shipping provider only.

pageSize Integer No

Specifies the pagesize. Defaults to 50, max value is 250

minimumShipmentId Integer No

Get Shipments with a shipment greater or equal than this id. New shipments have a greater id than older shipments.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.