--- title: "Order shipment created" method: POST path: "order.shipment.created" --- # Order shipment created `POST order.shipment.created` (webhook) When a shipment is created for an order ## Payload - union - WmsOrdersShipmentCreatedFullWebhook - `connection_id` string, required - `data` WmsOrderApiItemSchema, required - `id` string, required: The unique ID of the order. - `warehouse_customer_id` string, nullable, required: The ID of the merchant/tenant/customer that owns the order. Can be passed into the [Warehouse Customer](/api-reference/wms-api/warehouse-customers/get-item) endpoint for more details. - `warehouse_id` string, nullable, required: If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `created_date` string, date-time, required: The date the order was created. - `updated_date` string, date-time, required: The date the order was last updated. - `reference_id` string, required: An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. - `order_number` string, required: A user-friendly identifier for their order. Defaults to `reference_id` if not provided. - `status` 'open' | 'confirmed' | 'processing' | 'picked' | 'packed' | 'partially_fulfilled' | 'fulfilled' | 'exception' | 'cancelled' | 'backordered' | 'other', required: The status of the order. See the [order information](info) for more details. - `raw_status` string, nullable, required: The raw status (if available) returned directly from the WMS. - `channel_object` OrderChannel, required - `channel_id` string, required: The ID of the channel. - `channel_name` string, nullable, required: The name of the channel. - `type` 'd2c' | 'b2b' | 'dropship' | 'transfer', nullable, required: The type of order, such as d2c, b2b, dropship, or transfer. - `trading_partner` string, nullable, required: For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart). - `service_level` string, nullable, required: The type of shipping method requested by the customer. - `shipping_method_id` string, nullable, required: The ID of the actual shipping method used to ship the order. Can be passed into the [Shipping Method](/api-reference/wms-api/shipping-methods/get-item) endpoint for more details.. May vary from the shipping methods returned at the package level. - `shipping_method_name` string, nullable, required: The name of the shipping method used to ship the order. - `carrier_id` string, nullable, required: The ID of the carrier used to ship the order to the customer. May vary from the carriers returned at the package level. - `carrier_name` string, nullable, required: The name of the carrier used to ship the order to the customer. If carrier_id is also provided, that will take precedence. May vary from the carriers returned at the package level. - `scac` string, nullable, required: The Standard Carrier Alpha Code for the carrier used to ship the order. - `is_third_party_freight` boolean, nullable, required: True if the order was shipped using a third party freight account. - `third_party_freight_account_number` string, nullable, required: The third party freight account number used to ship the order. - `first_party_freight_account_number` string, nullable, required: The first party freight account number used to ship the order. - `invoice_currency_code` string, required: The currency used for this order. If not provided explicitly, defaults to USD. - `total_price` number, nullable, required: The total price a customer paid for the order. - `total_tax` number, nullable, required: The total tax on the order. - `total_discount` number, nullable, required: The total amount discounted from the order. - `total_shipping` number, nullable, required: The total shipping cost for the order incurred by the customer. - `ship_to_address` ShipToAddress, required - `full_name` string, nullable, required - `company` string, nullable, required - `address1` string, nullable, required - `address2` string, nullable, required - `address3` string, nullable, required - `city` string, nullable, required - `state` string, nullable, required - `postal_code` string, nullable, required - `country` string, nullable, required - `phone_number` string, nullable, required - `email_address` string, nullable, required - `line_items` WmsOrderLineItem[], required: List of the products included in the order. - `product_id` string, required: Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details. - `sku` string, nullable, required - `quantity` integer, required - `unit_price` number, nullable, required: The price of the product in the currency specified by `invoice_currency_code`. - `discount_amount` number, nullable, required: The amount discounted from the product for this order. - `tags` string[], required: A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as `key:value`. - `required_ship_date` string, date-time, nullable, required: The date the order must be shipped by. - `saturday_delivery` boolean, nullable, required: True if the order requires Saturday delivery. - `signature_required` boolean, nullable, required: True if the order requires a signature upon delivery. - `international_duty_paid_by` 'sender' | 'recipient' | 'third_party', nullable, required: The party responsible for paying international duties. - `shipments` OrderShipment[], required: List of the shipments sent out to the customer. - `shipment_id` string, required: The ID of the shipment. - `warehouse_id` string, required: The warehouse this order was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `raw_status` string, nullable, required: The raw status (if available) of the shipment returned directly from the WMS. - `status` 'open' | 'shipped' | 'cancelled' | 'other', required: The status of the shipment. - `shipped_date` string, date-time, nullable, required: The date the shipment was sent. - `line_items` ShipmentLineItem[], required: List of the inventory items listed in the shipment. - `inventory_item_id` string, required: The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. - `sku` string, nullable, required - `quantity` integer, required - `parent_product_id` string, nullable, required: The ID of the parent product if the line item is part of a kit. Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details. - `ship_to_address` ShipToAddress, required - `full_name` string, nullable, required - `company` string, nullable, required - `address1` string, nullable, required - `address2` string, nullable, required - `address3` string, nullable, required - `city` string, nullable, required - `state` string, nullable, required - `postal_code` string, nullable, required - `country` string, nullable, required - `phone_number` string, nullable, required - `email_address` string, nullable, required - `ship_from_address` ShipFromAddress, required - `address1` string, nullable, required - `address2` string, nullable, required - `address3` string, nullable, required - `city` string, nullable, required - `state` string, nullable, required - `postal_code` string, nullable, required - `country` string, nullable, required - `packages` Package[], required: A list of the packages included in the shipment. - `package_id` string, required: The ID of the package. - `package_name` string, nullable, required: The name of the package. (e.g. 12x9x4) - `tracking_number` string, nullable, required: The tracking number for the package. - `tracking_url` string, nullable, required: The URL for the tracking number. - `shipping_method_id` string, nullable, required: The ID of the shipping method returned at the package level. - `shipping_method_name` string, nullable, required: The name of the shipping method returned at the package level. - `carrier_id` string, nullable, required: The ID of the carrier used to ship the package. - `carrier_name` string, nullable, required: The name of the carrier used to ship the package. - `scac` string, nullable, required: The Standard Carrier Alpha Code for the carrier used to ship the package. - `bill_of_lading` string, nullable, required: The bill of lading number associated with the package's shipment. - `sscc` string, nullable, required: The Serial Shipping Container Code (GS1) identifying the package. - `pro_number` string, nullable, required: The PRO (freight tracking) number associated with the package's shipment. - `shipping_cost` number, nullable, required: The cost incurred by the warehouse to ship the package. - `measurements` PackageMeasurements, required - `length` number, nullable, required - `width` number, nullable, required - `height` number, nullable, required - `unit` 'cm' | 'in', nullable, required: The unit of measurement for the size of the package. - `weight` number, nullable, required - `weight_unit` 'kg' | 'oz' | 'lb', nullable, required: The unit of measurement for the weight of the package. - `line_items` PackageLineItem[], required: A list of the inventory items included in the package. - `inventory_item_id` string, required: The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. - `sku` string, nullable, required - `quantity` integer, required - `lot_id` string, nullable, required: The ID of the lot the inventory item was picked from. - `expiration_date` string, date-time, nullable, required: The expiration date of the lot the inventory item was picked from. - `parent_product_id` string, nullable, required: The ID of the parent product if the line item is part of a kit. Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details. - `external_system_url` string, nullable, required: URL link to the order in the external system (WMS/Freight etc). - `trackstar_tags` unknown[], nullable, required: A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. - unknown - `additional_fields` object, required: Integration-specific fields - `trackstar_created_date` string, date-time, required - `trackstar_updated_date` string, date-time, required - `event_type` 'order.shipment.created', required - `integration_name` string, required - `integration_type` string, required - `previous_attributes` ShipmentCreatedPreviousAttributes, required - `shipments` OrderShipment[], required: List of the shipments sent out to the customer. - `shipment_id` string, required: The ID of the shipment. - `warehouse_id` string, required: The warehouse this order was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. - `raw_status` string, nullable, required: The raw status (if available) of the shipment returned directly from the WMS. - `status` 'open' | 'shipped' | 'cancelled' | 'other', required: The status of the shipment. - `shipped_date` string, date-time, nullable, required: The date the shipment was sent. - `line_items` ShipmentLineItem[], required: List of the inventory items listed in the shipment. - `inventory_item_id` string, required: The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. - `sku` string, nullable, required - `quantity` integer, required - `parent_product_id` string, nullable, required: The ID of the parent product if the line item is part of a kit. Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details. - `ship_to_address` ShipToAddress, required - `full_name` string, nullable, required - `company` string, nullable, required - `address1` string, nullable, required - `address2` string, nullable, required - `address3` string, nullable, required - `city` string, nullable, required - `state` string, nullable, required - `postal_code` string, nullable, required - `country` string, nullable, required - `phone_number` string, nullable, required - `email_address` string, nullable, required - `ship_from_address` ShipFromAddress, required - `address1` string, nullable, required - `address2` string, nullable, required - `address3` string, nullable, required - `city` string, nullable, required - `state` string, nullable, required - `postal_code` string, nullable, required - `country` string, nullable, required - `packages` Package[], required: A list of the packages included in the shipment. - `package_id` string, required: The ID of the package. - `package_name` string, nullable, required: The name of the package. (e.g. 12x9x4) - `tracking_number` string, nullable, required: The tracking number for the package. - `tracking_url` string, nullable, required: The URL for the tracking number. - `shipping_method_id` string, nullable, required: The ID of the shipping method returned at the package level. - `shipping_method_name` string, nullable, required: The name of the shipping method returned at the package level. - `carrier_id` string, nullable, required: The ID of the carrier used to ship the package. - `carrier_name` string, nullable, required: The name of the carrier used to ship the package. - `scac` string, nullable, required: The Standard Carrier Alpha Code for the carrier used to ship the package. - `bill_of_lading` string, nullable, required: The bill of lading number associated with the package's shipment. - `sscc` string, nullable, required: The Serial Shipping Container Code (GS1) identifying the package. - `pro_number` string, nullable, required: The PRO (freight tracking) number associated with the package's shipment. - `shipping_cost` number, nullable, required: The cost incurred by the warehouse to ship the package. - `measurements` PackageMeasurements, required - `length` number, nullable, required - `width` number, nullable, required - `height` number, nullable, required - `unit` 'cm' | 'in', nullable, required: The unit of measurement for the size of the package. - `weight` number, nullable, required - `weight_unit` 'kg' | 'oz' | 'lb', nullable, required: The unit of measurement for the weight of the package. - `line_items` PackageLineItem[], required: A list of the inventory items included in the package. - `inventory_item_id` string, required: The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. - `sku` string, nullable, required - `quantity` integer, required - `lot_id` string, nullable, required: The ID of the lot the inventory item was picked from. - `expiration_date` string, date-time, nullable, required: The expiration date of the lot the inventory item was picked from. - `parent_product_id` string, nullable, required: The ID of the parent product if the line item is part of a kit. Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details. - WmsOrdersShipmentCreatedTruncatedWebhook - `connection_id` string, required - `data` WmsOrdersShipmentCreatedTruncatedData, required - `id` string: The record this event is about. Absent on connection webhooks, which carry dates rather than a row. - `event_type` 'order.shipment.created', required - `integration_name` string, required - `integration_type` string, required - `previous_attributes` WmsOrdersShipmentCreatedTruncatedPreviousAttributes, required - `data_truncated` boolean, required: Always true on this shape. The event was too large to send in full, so `data` holds only the `id` and `previous_attributes` is empty. - `data_url` string, required: Called with your usual API key, it returns a download link for this event exactly as it would have been delivered. ## Acknowledgement `200` Success --- [API](https://skmtc.dev/trackstarhq/apis/trackstar-api.md) - [All operations](https://skmtc.dev/trackstarhq/apis/trackstar-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trackstarhq/apis/trackstar-api/revisions/08647f790594?raw)