shipments

Get list of Shipments

get/v1/shipments

Request

  • Base URL: https://api.shipengine.com
  • URL: https://api.shipengine.com/v1/shipments
  • Auth: API key in header API-Key

Query parameters

shipment_status'pending' | 'processing' | 'label_purchased' | 'cancelled'

The possible shipment status values

batch_idstring

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

Example:se-28529731

Batch ID

tagstring

Filter shipments by tag name. Returns only shipments that have been assigned the specified tag. You can filter by one tag at a time. Tags are arbitrary strings used to categorize shipments (e.g., "Priority", "Fragile", "International").

created_at_startstring date-time

Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)

created_at_endstring date-time

Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)

modified_at_startstring date-time

Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)

modified_at_endstring date-time

Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)

pageinteger

Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.

page_sizeinteger

The number of results to return per response.

sales_order_idstring

Sales Order ID

sort_dir'asc' | 'desc'

Controls the sort order of queries

ValueDescription
ascReturn results in ascending order
descReturn results in descending order

Controls the sort order of the query.

sort_by'modified_at' | 'created_at'

The possible shipments sort by values

Response

The request was a success.

totalinteger required

Total number of shipments returned by the api call

pageinteger required
pagesinteger required

Changes

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new bring_your_own_label_not_supported enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new multiple_sales_orders enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • warning

      added the new sales_order_link_required enum value to the // response property for the response status

    • info

      added the optional property ////// to the response with the status

    • info

      added subschema #2: shipment_sales_order_fields to the // response property allOf list for the response status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the //////// response's property type changed from no type to string for status

    • breaking

      the /////// response's property type changed from no type to string for status

    • breaking

      the //////// response's property type changed from no type to string for status

    • breaking

      the ///// response's property type changed from no type to string for status

    • breaking

      the ////////// response's property type changed from no type to string for status

    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the //// response's property type changed from no type to string for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the //////// response's property type changed from no type to string for status

    • breaking

      the //////// response's property type changed from no type to string for status

    • breaking

      the //////// response's property type changed from no type to string for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the ////// response's property type changed from no type to string for status

    • warning

      added the new amazon_ca enum value to the //// response property for the response status

    • warning

      added the new amazon_us enum value to the //// response property for the response status

    • warning

      added the new any enum value to the /////// response property for the response status

    • warning

      added the new brightpearl enum value to the //// response property for the response status

    • warning

      added the new cash enum value to the /////// response property for the response status

    • warning

      added the new cash_equivalent enum value to the /////// response property for the response status

    • warning

      added the new channel_advisor enum value to the //// response property for the response status

    • warning

      added the new cratejoy enum value to the //// response property for the response status

    • warning

      added the new ebay enum value to the //// response property for the response status

    • warning

      added the new etsy enum value to the //// response property for the response status

    • warning

      added the new gram enum value to the //////// response property for the response status

    • warning

      added the new gram enum value to the ////////// response property for the response status

    • warning

      added the new gram enum value to the ////// response property for the response status

    • warning

      added the new groupon_goods enum value to the //// response property for the response status

    • warning

      added the new jane enum value to the //// response property for the response status

    • warning

      added the new kilogram enum value to the //////// response property for the response status

    • warning

      added the new kilogram enum value to the ////////// response property for the response status

    • warning

      added the new kilogram enum value to the ////// response property for the response status

    • warning

      added the new magento enum value to the //// response property for the response status

    • warning

      added the new none enum value to the /////// response property for the response status

    • warning

      added the new ounce enum value to the //////// response property for the response status

    • warning

      added the new ounce enum value to the ////////// response property for the response status

    • warning

      added the new ounce enum value to the ////// response property for the response status

    • warning

      added the new paypal enum value to the //// response property for the response status

    • warning

      added the new pound enum value to the //////// response property for the response status

    • warning

      added the new pound enum value to the ////////// response property for the response status

    • warning

      added the new pound enum value to the ////// response property for the response status

    • warning

      added the new seller_active enum value to the //// response property for the response status

    • warning

      added the new shopify enum value to the //// response property for the response status

    • warning

      added the new squarespace enum value to the //// response property for the response status

    • warning

      added the new stitch_labs enum value to the //// response property for the response status

    • warning

      added the new three_dcart enum value to the //// response property for the response status

    • warning

      added the new tophatter enum value to the //// response property for the response status

    • warning

      added the new volusion enum value to the //// response property for the response status

    • warning

      added the new walmart enum value to the //// response property for the response status

    • warning

      added the new woo_commerce enum value to the //// response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      removed from the /////// response property allOf list for the response status

    • info

      removed from the //////// response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the / response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      removed from the //// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the //////// response property allOf list for the response status

    • info

      removed from the //////// response property allOf list for the response status

    • info

      removed from the //////// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the ///// response property allOf list for the response status

    • info

      removed from the //////// response property allOf list for the response status

    • info

      removed from the ////////// response property allOf list for the response status

    • info

      removed from the ////// response property allOf list for the response status

    • info

      the ///// response's property pattern ^se(-[a-z0-9]+)+$ was added for the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status