Skip to content

shipment object

A shipment object contains the properties that define a shipment in DropStream.

Shipments are listed by the /shipments endpoint methods.

shipment schema

{
  "id": integer,
  "tracking_number": "string",
  "created_at": "dateString",
  "order_id": integer,
  "shipped_at": "dateString",
  "weight": "decimal(8,2)",
  "external_shipping_description": "string",
  "carrier_name": "string",
  "service_level": "string",
  "warehouse_id": integer,
  "state": "string",
  "bill_of_lading_number": "string",
  "dispatch_number": "string",
  "external_shipment_id": "string",
  "master_bill_of_lading_number": "string",
  "order_items": [
    {
      "id": integer
    },
    {
      "id": integer
    }
(Additional order_items if any...)
  ]
}

shipment properties

bill_of_lading_number

Propertybill_of_lading_number
Data typestring
DescriptionBill of lading number

carrier_name

Propertycarrier_name
Data typeCarrier name
DescriptionCarrier name
ExampleFedEx

composite_tracking_number

Propertycomposite_tracking_number
Data typestring
DescriptionComposite tracking number

created_at

Propertycreated_at
Data typedateString
DescriptionDateTime when the shipment was imported from the WMS
Example2022-09-10T08:28:27Z

dispatch_number

Propertydispatch_number
Data typestring
DescriptionDispatch number

expected_delivery_date

Propertyexpected_delivery_date
Data typedateString
DescriptionExpected delivery date
Example2022-09-10T08:28:27Z

external_shipment_id

Propertyexternal_shipment_id
Data typestring
DescriptionExternal shipment ID

external_shipping_description

Propertyexternal_shipping_description
Data typestring
DescriptionExternal shipping description
Example"2nd Day Air"

id

Propertyid
Data typeinteger
DescriptionUnique ID of this shipment, assigned upon creation
NoteIn other contexts, "shipment_id" refers to this property
Example123456789

master_bill_of_lading_number

Propertymaster_bill_of_lading_number
Data typestring
DescriptionMaster bill of lading number

notified_at

Propertynotified_at
Data typedateString
DescriptionDateTime when the shipment was notified to the sales channel
Example2022-09-10T08:28:27Z

order_id

Propertyorder_id
Data typeinteger
DescriptionDropStream Order ID associated with this shipment
Example123456789

order_items

Propertyorder_items
Data typeobject
DescriptionArray of objects with the numeric id (integer) of any item(s) in this shipment
Example
[
  {
    "id": 123456789
  }
  {
    "id": 123456789
  }
]

pro_number

Propertypro_number
Data typestring
DescriptionPRO Number

scac_code

Propertyscac_code
Data typestring
DescriptionStandard Carrier Alpha Code

serial_number

Propertyserial_number
Data typestring
DescriptionSerial number

service_level

Propertyservice_level
Data typestring
DescriptionService level
Example"Ground"

shipped_at

Propertyshipped_at
Data typedateString
DescriptionDateTime when the package was shipped
Example2022-09-10T08:28:27Z

shipping_carrier_description_code

Propertyshipping_carrier_description_code
Data typestring
DescriptionShipping carrier description code

state

Propertystate
Data typestring
DescriptionStatus of the shipment in DropStream. Shipment states include:
  • new
  • ready_for_shipment_notification
  • scheduled_notify_of_shipment
  • scheduled_processing_shipment
  • errored_processing
  • scheduled_notify_of_shipment
  • delayed_notifying_of_shipment
  • errored_notifying_of_shipment
  • notified_shipped
  • archived
Example"notified_shipped"

tracking_number

Propertytracking_number
Data typestring
DescriptionTracking number
Example"123456789"

tracking_url

Propertytracking_url
Data typestring
DescriptionTracking URL

warehouse_id

Propertywarehouse_id
Data typeinteger
DescriptionNumeric DropStream ID of the shipping warehouse