Sign in

v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Shipments

Search shipments

Search for specific shipment details or get all existing shipment details. Shipments are automatically created based on the Item/Offer configuration. If Item is shippable a shipment is created. How many and how frequently a shipment is scheduled is dependant on the Offer. A shipment can contain a single or multiple items.

get/shipments

Query parameters

shipment_idstring

Search for specific shipment ID(s). Comma separate for multiple.

order_idinteger

Search for shipments belonging to a specific order ID.

customer_idinteger

Search for shipments belonging to a specific customer ID.

shipment_tracking_idstring

Search for shipments tby tracking number.

date_created_fromstring date-time
Example:2023-04-01 00:00:00

Return only shipments that were created on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_created_tostring date-time
Example:2023-04-01 00:00:00

Return only shipments that were created on or before this date. Required when passing date_created_from. Maximum date range: 31 days.

date_complete_fromstring date-time
Example:2023-04-01 00:00:00

Return only shipments that were completed (shipped) on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_complete_tostring date-time
Example:2023-04-01 00:00:00

Return only shipments that were completed (shipped) on or before this date. Required when passing date_complete_from. Maximum date range: 31 days.

date_scheduled_fromstring date-time
Example:2023-04-01 00:00:00

Return only shipments that were scheduled on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_scheduled_tostring date-time
Example:2023-04-01 00:00:00

Return only shipments that were scheduled on or before this date. Required when passing date_scheduled_from. Maximum date range: 31 days.

date_cancel_fromstring date-time
Example:2023-04-01 00:00:00

Return only shipments that were cancelled on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_cancel_tostring date-time
Example:2023-04-01 00:00:00

Return only shipments that were cancelled on or before this date. Required when passing date_cancel_from. Maximum date range: 31 days.

date_post_fromstring date-time
Example:2023-04-01 00:00:00

Return only shipments that were posted to fulfillment on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_post_tostring date-time
Example:2023-04-01 00:00:00

Return only shipments that were posted to fulfillment on or before this date. Required when passing date_post_from. Maximum date range: 31 days.

date_scan_fromstring date-time
Example:2023-04-01 00:00:00

Return only shipments that were scanned by a carrier on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_scan_tostring date-time
Example:2023-04-01 00:00:00

Return only shipments that were scanned by a carrier on or before this date. Required when passing date_scan_from. Maximum date range: 31 days.

date_deliver_fromstring date-time
Example:2023-04-01 00:00:00

Return only shipments that were delivered on or after this date. A date to and from field is required when not passing shipment ID(s), a customer ID, an order ID, or shipment tracking ID (tracking number).

date_deliver_tostring date-time
Example:2023-04-01 00:00:00

Return only shipments that were delivered on or before this date. Required when passing date_deliver_from. Maximum date range: 31 days.

campaign_idinteger

Search for shipments belonging to a specific campaign ID.

item_skustring

Search for shipments that have a specific item sku.

connection_idinteger

Search for shipments by the fulfillment connection ID.

shipment_status_id1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9
  • 1 - Pending Post
  • 2 - Pending Tracking
  • 3 - Cancelled
  • 4 - Shipped
  • 5 - Error
  • 6 - Delivered
  • 7 - Declined
  • 8 - Pending Transaction
  • 9 - Skipped

Search for shipments by status.

  • 1 - Pending Post
  • 2 - Pending Tracking
  • 3 - Cancelled
  • 4 - Shipped
  • 5 - Error
  • 6 - Delivered
  • 7 - Declined
  • 8 - Pending Transaction
  • 9 - Skipped
is_testboolean

Search for shipments that are associated with test orders.

shipment_parent_type_idnull | 1 | 2 | 3 | 4 nullable
  • 1 - Reship
  • 2 - Reward
  • 3 - Gift
  • 4 - Free

Search for shipments that were not created at the time that the order was placed.

  • 1 - Reship
  • 2 - Reward
  • 3 - Gift
  • 4 - Free
  • 5 - Split
ship_citystring

Search for shipments that are being sent to a specific city.

ship_statestring

Search for shipments that are being sent to a specific state.

ship_zipcodestring

Search for shipments that are being sent to a specific zipcode.

ship_countrystring

Search for shipments that are being sent to a specific country. 2 letters (example : US).

shipment_rmastring

Search for shipments by RMA

rma_status_idnull | 1 | 2 nullable
  • 1 - Pending Return
  • 2 - Returned

Search for shipments by RMA status.

  • 1 - Pending Return
  • 2 - Returned
with'shipment_items' | 'customer_address_billing' | 'customer_address_shipping' | 'campaign' | 'connection' | 'tracking_history' | 'actions'

Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=shipment_items,customer_address_shipping)

limitinteger

Limit the number of results. Default: 25, max: 200.

offsetinteger

Offset the results

sort_bystring

Field to sort result by

order'asc' | 'desc'

Order by asc or desc

Response

OK

totalinteger

Example response

{
  "shipments": [
    {
      "date_cancel": "2023-04-01 00:00:00",
      "date_scheduled": "2023-04-01 00:00:00",
      "date_complete": "2023-04-01 00:00:00",
      "date_scan": "2023-04-01 00:00:00",
      "date_deliver": "2023-04-01 00:00:00",
      "date_return": "2023-04-01 00:00:00",
      "date_skip": "2023-04-01 00:00:00",
      "date_rma": "2023-04-01 00:00:00",
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00",
      "customer_address_billing": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "customer_address_shipping": {
        "date_created": "2023-04-01 00:00:00",
        "date_modified": "2023-04-01 00:00:00"
      },
      "tracking_history": [
        {
          "date": "2023-04-01 00:00:00"
        }
      ]
    }
  ]
}