> ## Documentation Index > Fetch the complete documentation index at: https://docs.trackstarhq.com/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Trackstar is a unified REST API for WMS, cart, and carrier systems. Base URL: https://production.trackstarhq.com. There is no SDK; call the API with plain HTTP. > Send x-trackstar-api-key on every request. Endpoints scoped to one connection also need x-trackstar-access-token. Read both from environment variables and never print them. > Reads return data Trackstar has already synced from the connected system. Writes (POST, PUT, PATCH, DELETE) are forwarded to the connected system immediately. > A new connection has no data until its initial sync finishes. Wait for the connection.historical-sync-completed webhook, or poll GET /connections/{connection_id} and check historical_sync_completed. > List endpoints page with page_token and next_token (limit is capped at 1000). Repeat every filter on every page. Filters use field[operator]=value, for example created_date[gte]=2026-01-01T00:00:00Z. > Write bodies must not contain null or empty strings; omit the field instead. Call GET /integrations/{integration_type}/{integration_name}/write-info first to learn the exact fields an integration accepts. > To test without real credentials, POST /sandbox/generate-sandbox/{wms|cart|carrier} with the API key returns a sandbox access token. Start at https://docs.trackstarhq.com/how-to-guides/build-with-ai.md and install the skills with: npx skills add https://docs.trackstarhq.com # Ship Order > Marks the order as fulfilled and passes in the provided shipment and package information. Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint. ## OpenAPI ````yaml post /wms/orders/{order_id}/shipments openapi: 3.1.0 info: description: > Trackstar is a Unified API that provides standard endpoints for Supply Chain Logistics. We currently offer an API for Warehouse Management Systems (WMS). title: Trackstar API version: 0.1.0 servers: - description: Trackstar API url: https://production.trackstarhq.com security: [] tags: [] externalDocs: description: Trackstar API Documentation url: https://docs.trackstarhq.com paths: /wms/orders/{order_id}/shipments: post: tags: - wms - Orders summary: Ship Order description: >- Marks the order as fulfilled and passes in the provided shipment and package information. Get the required, optional, and integration specific fields by calling the [integrations](/api-reference/mgmt/integrations) endpoint. operationId: post_wms_create_order_shipment parameters: - in: path name: order_id schema: type: string required: true - in: header name: x-trackstar-api-key description: Your organization-level Trackstar API key. schema: type: string example: required: true - in: header name: x-trackstar-access-token description: >- Your user's access token for a specific integration (ShipHero, Extensiv, etc). schema: type: string example: required: true - in: header name: Idempotency-Key description: >- Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours. schema: type: string minLength: 1 maxLength: 255 example: 9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00 required: false requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateShipmentwmsOrderInputSchema' responses: '200': content: application/json: schema: $ref: '#/components/schemas/wmsCreateShipmentOrderResponse' description: Successful response '404': content: application/json: schema: $ref: '#/components/schemas/HTTPError' description: Not found '422': content: application/json: schema: $ref: '#/components/schemas/ValidationError' description: Validation error components: schemas: CreateShipmentwmsOrderInputSchema: type: object properties: {} additionalProperties: false oneOf: - $ref: '#/components/schemas/CreateShipmentwmsOrder--WMS__Sandbox--' - $ref: >- #/components/schemas/CreateShipmentwmsOrder--Cin7__Core__-_Dear__Systems_--- - $ref: '#/components/schemas/CreateShipmentwmsOrder--Deposco--' - $ref: >- #/components/schemas/CreateShipmentwmsOrder--Extensiv__-_3PL__Central_--- - $ref: '#/components/schemas/CreateShipmentwmsOrder--Amazon--' - $ref: '#/components/schemas/CreateShipmentwmsOrder--Finale--' - $ref: '#/components/schemas/CreateShipmentwmsOrder--Infoplus--' - $ref: '#/components/schemas/CreateShipmentwmsOrder--Linnworks--' - $ref: '#/components/schemas/CreateShipmentwmsOrder--Logiwa--' - $ref: '#/components/schemas/CreateShipmentwmsOrder--Logiwa__IO--' - $ref: '#/components/schemas/CreateShipmentwmsOrder--Luminous--' - $ref: '#/components/schemas/CreateShipmentwmsOrder--Packiyo--' - $ref: '#/components/schemas/CreateShipmentwmsOrder--ShipHero--' - $ref: '#/components/schemas/CreateShipmentwmsOrder--ShipStation--' - $ref: >- #/components/schemas/CreateShipmentwmsOrder--Linnworks__Core__-_SKUVault_--- title: CreateShipmentwmsOrderInputSchema wmsCreateShipmentOrderResponse: type: object properties: data: $ref: '#/components/schemas/CreateWmsOrderShipmentResponseDataSchema' id: type: string description: The ID of the object that has been created or modified example: id unused_fields: type: array description: Unused fields items: type: string description: '' example: unused_fields required: - id - unused_fields additionalProperties: false title: wmsCreateShipmentOrderResponse HTTPError: properties: error: type: string id: type: string description: The ID of the item that wasn't found. required: - error type: object title: HTTPError ValidationError: properties: error: type: string detail: type: object properties: : type: object properties: : type: array items: type: string required: - error type: object title: ValidationError CreateShipmentwmsOrder--WMS__Sandbox--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} shipped_date: type: string format: date-time description: The date the shipment was sent. example: '2022-05-06T01:02:03Z' tracking_number: type: string description: The tracking number for the package. example: tracking_number tracking_url: type: string description: The URL for the tracking number. example: tracking_url carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex shipping_method_id: type: string enum: - N/A - Connect an account to see options description: >- 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.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_cost: type: number description: The cost incurred by the warehouse to ship the package. example: 2.5 measurements: $ref: '#/components/schemas/ShipmentMeasurements' warehouse_id: type: string enum: - N/A - Connect an account to see options description: >- 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. example: warehouse_id line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderCreateOrderShipmentLineItemsandbox' required: - measurements - shipped_date - shipping_cost - tracking_number - warehouse_id additionalProperties: false title: WMS Sandbox CreateShipmentwmsOrder--Cin7__Core__-_Dear__Systems_---: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} carrier_id: type: string enum: - Connect an account to see available carriers description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex carrier: type: string enum: - Connect an account to see available carriers description: The carrier to use for the shipment example: carrier tracking_number: type: string description: The tracking number for the package. example: tracking_number additionalProperties: false title: Cin7 Core (Dear Systems) CreateShipmentwmsOrder--Deposco--: type: object properties: tracking_number: type: string description: The tracking number for the package. example: tracking_number shipping_cost: type: number description: The cost incurred by the warehouse to ship the package. example: 2.5 packages: type: array description: A list of packages with their desired tracking numbers. example: - package_id: package_id tracking_number: tracking_number items: $ref: '#/components/schemas/PackageTracking' required: - shipping_cost additionalProperties: false title: Deposco CreateShipmentwmsOrder--Extensiv__-_3PL__Central_---: type: object properties: shipped_date: type: string format: date-time description: The date the shipment was sent. example: '2022-05-06T01:02:03Z' confirm_date: type: string format: date-time description: The date the shipment was sent. Defaults to the current time. example: '2022-05-06T01:02:03Z' tracking_number: type: string description: The tracking number for the package. example: tracking_number carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex shipping_method_id: type: string description: >- 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.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_cost: type: number description: The cost incurred by the warehouse to ship the package. example: 2.5 packages: type: array description: A list of packages with their desired tracking numbers. example: - package_id: package_id tracking_number: tracking_number items: $ref: '#/components/schemas/PackageTracking' confirm_order: type: boolean default: true description: >- Whether to confirm the order in Extensiv, which closes it. Defaults to true. When false, the tracking number, carrier and shipped date are written to the order, the order is left open, and the response is only `{"success": true, "id": ""}` instead of the full order. `shipping_cost` is added to the order as its shipping charge. `confirm_date` can't be sent when false. example: true required: - shipped_date additionalProperties: false title: Extensiv (3PL Central) CreateShipmentwmsOrder--Amazon--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} shipped_date: type: string format: date-time description: The date the shipment was sent. example: '2022-05-06T01:02:03Z' tracking_number: type: string description: The tracking number for the package. example: tracking_number carrier_id: type: string description: The ID of the carrier used to ship the order. example: carrier_id carrier_name: type: string description: The name of the carrier used to ship the order. example: carrier_name shipping_method_id: type: string description: The ID of the actual shipping method. example: shipping_method_id required: - shipped_date - tracking_number additionalProperties: false title: Amazon CreateShipmentwmsOrder--Finale--: type: object properties: tracking_number: type: string description: The tracking number for the package. example: tracking_number line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 location_id: location_id items: $ref: '#/components/schemas/WmsOrderWriteLineItemfinale' required: - line_items additionalProperties: false title: Finale CreateShipmentwmsOrder--Infoplus--: type: object properties: tracking_number: type: string description: The tracking number for the package. example: tracking_number shipping_method_id: type: string description: >- 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.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground tracking_numbers: type: array description: List of tracking numbers if there are multiple shipments example: - tracking_number_1 - tracking_number_2 - tracking_number_3 items: type: string description: Tracking number example: tracking_number additionalProperties: false title: Infoplus CreateShipmentwmsOrder--Linnworks--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} tracking_number: type: string description: The tracking number for the package. example: tracking_number shipping_cost: type: number description: The cost incurred by the warehouse to ship the package. example: 2.5 required: - tracking_number additionalProperties: false title: Linnworks CreateShipmentwmsOrder--Logiwa--: type: object properties: carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex carrier_name: type: string description: >- 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. example: FedEx shipping_method_id: type: string description: >- 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.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground tracking_number: type: string description: The tracking number for the package. example: tracking_number tracking_numbers: type: array description: List of tracking numbers associated with the order shipment. example: - tracking_number_1 - tracking_number_2 items: type: string description: Tracking number example: tracking_number required: - shipping_method_id additionalProperties: false title: Logiwa CreateShipmentwmsOrder--Logiwa__IO--: type: object properties: trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} tracking_number: type: string description: The tracking number for the package. example: tracking_number carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex carrier_name: type: string description: >- 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. example: FedEx shipping_method_id: type: string description: >- 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.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground files: type: array description: >- A list of files to attach to the order shipment. Will upload a dummy PDF if not provided. example: - file_name: example.pdf file_url: https://doc.phomemo.com/Labels-Sample.pdf items: $ref: '#/components/schemas/LogiwaIOFile' additionalProperties: false title: Logiwa IO CreateShipmentwmsOrder--Luminous--: type: object properties: shipped_date: type: string format: date-time description: The date the shipment was sent. example: '2022-05-06T01:02:03Z' tracking_number: type: string description: The tracking number for the package. example: tracking_number carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex shipping_method_id: type: string description: >- 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.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_cost: type: number description: The cost incurred by the warehouse to ship the package. example: 2.5 warehouse_id: type: string description: >- 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. example: warehouse_id line_items: type: array description: List of the products included in the order. example: - sku: sku product_id: 0 quantity: 1 items: $ref: '#/components/schemas/WmsOrderFulfillLineItemluminous' required: - carrier_id - line_items - shipped_date - tracking_number - warehouse_id additionalProperties: false title: Luminous CreateShipmentwmsOrder--Packiyo--: type: object properties: shipping_cost: type: number description: The cost incurred by the warehouse to ship the package. example: 2.5 tracking_number: type: string description: The tracking number for the package. example: tracking_number tracking_url: type: string description: The URL for the tracking number. example: tracking_url boxes: type: array description: A list of boxes with their desired tracking numbers. example: - measurements: length: length width: width height: height weight: weight weight_unit: weight_unit unit: unit package_name: package_name line_items: - sku: sku quantity: quantity items: $ref: '#/components/schemas/PackiyoBox' required: - boxes - shipping_cost - tracking_number - tracking_url additionalProperties: false title: Packiyo CreateShipmentwmsOrder--ShipHero--: type: object properties: warehouse_id: type: string description: >- 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. example: warehouse_id carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex shipping_method_id: type: string description: >- 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.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_method_name: type: string description: >- The name of the shipping method used to ship the order. If shipping_method_id is also provided, that will take precedence. May vary from the shipping methods returned at the package level. example: FedEx Ground shipping_cost: type: number description: The cost incurred by the warehouse to ship the package. example: 2.5 measurements: $ref: '#/components/schemas/OrderShipmentMeasurements' label_url: type: string description: URL where the label can be found example: label_url tracking_number: type: string description: The tracking number for the package. example: tracking_number tracking_url: type: string description: The URL for the tracking number. example: tracking_url required: - carrier_id - measurements - shipping_cost - warehouse_id additionalProperties: false title: ShipHero CreateShipmentwmsOrder--ShipStation--: type: object properties: carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex shipped_date: type: string format: date-time description: The date the shipment was sent. example: '2022-05-06T01:02:03Z' tracking_number: type: string description: The tracking number for the package. example: tracking_number notify_customer: type: boolean description: Specifies whether the customer should be notified of the shipment example: true notify_sales_channel: type: boolean description: >- Specifies whether the sales channel should be notified of the shipment example: true skip_retrieval: type: boolean default: false description: Skip resource retrieval after successful create operation example: false required: - carrier_id additionalProperties: false title: ShipStation CreateShipmentwmsOrder--Linnworks__Core__-_SKUVault_---: type: object properties: warehouse_id: type: string description: >- 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. example: warehouse_id carrier_id: type: string description: >- The ID of the carrier used to ship the order to the customer. If carrier_name is also provided, this will take precedence. example: fedex shipping_method_id: type: string description: >- 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.. If shipping_method_name is also provided, this will take precedence. example: fedex_ground shipping_cost: type: number description: The cost incurred by the warehouse to ship the package. example: 2.5 measurements: $ref: '#/components/schemas/ShipmentMeasurementsskuvault' tracking_number: type: string description: The tracking number for the package. example: tracking_number tracking_url: type: string description: The URL for the tracking number. example: tracking_url source: type: string default: External description: Where the shipping information came from. example: External note: type: string description: Note for the shipment. example: note line_items: type: array description: List of the products included in the order. example: - sku: sku quantity: 0 items: $ref: '#/components/schemas/WmsOrderFulfillLineItemskuvault' required: - carrier_id - measurements - shipping_method_id - tracking_number - tracking_url - warehouse_id additionalProperties: false title: Linnworks Core (SKUVault) CreateWmsOrderShipmentResponseDataSchema: type: object properties: id: type: string description: The unique ID of the order. example: order_id warehouse_customer_id: type: - string - 'null' description: >- 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. example: warehouse_customer_id warehouse_id: type: - string - 'null' description: >- 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. example: warehouse_id created_date: type: string format: date-time description: The date the order was created. example: '2022-01-01T00:00:00Z' updated_date: type: string format: date-time description: The date the order was last updated. example: '2022-01-02T05:05:05Z' reference_id: type: string description: >- An external unique identifier for the order, such as a Shopify order id. Defaults to `id` if client has not defined one. example: order_reference_id order_number: type: string description: >- A user-friendly identifier for their order. Defaults to `reference_id` if not provided. example: order_number status: type: string enum: - open - confirmed - processing - picked - packed - partially_fulfilled - fulfilled - exception - cancelled - backordered - other description: >- The status of the order. See the [order information](info) for more details. example: fulfilled raw_status: type: - string - 'null' description: The raw status (if available) returned directly from the WMS. example: raw_status channel_object: anyOf: - $ref: '#/components/schemas/OrderChannel' - type: 'null' type: type: - string - 'null' enum: - d2c - b2b - dropship - transfer description: The type of order, such as d2c, b2b, dropship, or transfer. example: d2c trading_partner: type: - string - 'null' description: >- For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart). example: Target service_level: type: - string - 'null' description: The type of shipping method requested by the customer. example: Standard shipping_method_id: type: - string - 'null' description: >- 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. example: fedex_ground shipping_method_name: type: - string - 'null' description: The name of the shipping method used to ship the order. example: FedEx Ground carrier_id: type: - string - 'null' description: >- The ID of the carrier used to ship the order to the customer. May vary from the carriers returned at the package level. example: fedex carrier_name: type: - string - 'null' description: >- 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. example: FedEx scac: type: - string - 'null' description: >- The Standard Carrier Alpha Code for the carrier used to ship the order. example: scac is_third_party_freight: type: - boolean - 'null' description: True if the order was shipped using a third party freight account. example: false third_party_freight_account_number: type: - string - 'null' description: The third party freight account number used to ship the order. example: '123456' first_party_freight_account_number: type: - string - 'null' description: The first party freight account number used to ship the order. example: '123456' invoice_currency_code: type: string description: >- The currency used for this order. If not provided explicitly, defaults to USD. example: USD total_price: type: - number - 'null' description: The total price a customer paid for the order. example: 13.49 total_tax: type: - number - 'null' description: The total tax on the order. example: 1.5 total_discount: type: - number - 'null' description: The total amount discounted from the order. example: 2.5 total_shipping: type: - number - 'null' description: The total shipping cost for the order incurred by the customer. example: 3.5 ship_to_address: $ref: '#/components/schemas/ShipToAddress' line_items: type: array description: List of the products included in the order. example: - product_id: product_id sku: sku quantity: 1 unit_price: 10.99 discount_amount: 1.5 items: $ref: '#/components/schemas/WmsOrderLineItem' tags: type: array description: >- 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`. example: - tag_0 items: type: string description: A tag associated with the order. example: tag_0 required_ship_date: type: - string - 'null' format: date-time description: The date the order must be shipped by. example: '2021-01-01T12:00:00Z' saturday_delivery: type: - boolean - 'null' description: True if the order requires Saturday delivery. example: false signature_required: type: - boolean - 'null' description: True if the order requires a signature upon delivery. example: false international_duty_paid_by: type: - string - 'null' enum: - sender - recipient - third_party description: The party responsible for paying international duties. example: sender shipments: type: array description: List of the shipments sent out to the customer. example: - shipment_id: shipment_id warehouse_id: wh_id shipped_date: '2022-05-06T01:02:03Z' raw_status: raw_status status: shipped line_items: - inventory_item_id: item_id sku: sku quantity: 1 parent_product_id: null ship_to_address: full_name: John Doe company: company address1: address1 address2: address2 address3: address3 city: city state: state postal_code: postal_code country: country ship_from_address: address1: address1 address2: address2 address3: address3 city: city state: state postal_code: postal_code country: country packages: - package_id: package_id package_name: package_name tracking_number: tracking_number tracking_url: tracking_url shipping_method_id: shipping_method_id shipping_method_name: shipping_method_name carrier_id: carrier_id carrier_name: carrier_name scac: scac bill_of_lading: bill_of_lading sscc: sscc pro_number: pro_number shipping_cost: 1 measurements: length: 1 width: 1 height: 1 unit: in weight: 1 weight_unit: lb line_items: - inventory_item_id: item_id sku: sku quantity: 1 lot_id: lot_id expiration_date: '2022-06-06T01:02:03Z' parent_product_id: null items: $ref: '#/components/schemas/OrderShipment' external_system_url: type: - string - 'null' description: URL link to the order in the external system (WMS/Freight etc). example: https://example.com/order/123 trackstar_tags: type: - array - 'null' description: >- A list of custom tags associated with the resource. A tag can be either a string or a dictionary with one key-value pair. example: - tag1 - tag2 - tag3: value3 items: {} additional_fields: type: object description: Integration-specific fields example: key: value additionalProperties: {} trackstar_created_date: type: string format: date-time description: '' example: '2023-03-15T13:45:30Z' trackstar_updated_date: type: string format: date-time description: '' example: '2023-03-15T13:45:30Z' required: - additional_fields - carrier_id - carrier_name - channel_object - created_date - external_system_url - first_party_freight_account_number - id - international_duty_paid_by - invoice_currency_code - is_third_party_freight - line_items - order_number - raw_status - reference_id - required_ship_date - saturday_delivery - scac - service_level - ship_to_address - shipments - shipping_method_id - shipping_method_name - signature_required - status - tags - third_party_freight_account_number - total_discount - total_price - total_shipping - total_tax - trackstar_created_date - trackstar_tags - trackstar_updated_date - trading_partner - type - updated_date - warehouse_customer_id - warehouse_id additionalProperties: false title: CreateWmsOrderShipmentResponseDataSchema ShipmentMeasurements: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the shipment. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the shipment. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: ShipmentMeasurements WmsOrderCreateOrderShipmentLineItemsandbox: type: object properties: sku: type: string enum: - N/A - Connect an account to see options description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderCreateOrderShipmentLineItemsandbox PackageTracking: type: object properties: package_id: type: string description: The ID of the package. example: package_id tracking_number: type: string description: The tracking number for the package. example: tracking_number required: - package_id - tracking_number additionalProperties: false title: PackageTracking WmsOrderWriteLineItemfinale: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 location_id: type: string description: '' example: location_id required: - location_id - sku additionalProperties: false title: WmsOrderWriteLineItemfinale LogiwaIOFile: type: object properties: file_url: type: string description: The URL of the file to attach. example: https://doc.example.com/example.pdf file_name: type: string description: The name of the file to attach. example: example.pdf required: - file_name - file_url additionalProperties: false title: LogiwaIOFile WmsOrderFulfillLineItemluminous: type: object properties: sku: type: string description: '' example: sku product_id: type: integer description: '' example: 0 quantity: type: integer minimum: 1 description: '' example: 1 required: - quantity additionalProperties: false title: WmsOrderFulfillLineItemluminous PackiyoBox: type: object properties: measurements: $ref: '#/components/schemas/PackageMeasurementspackiyo' package_name: type: string enum: - N/A - Connect an account to see available boxes description: package_name example: package_name line_items: type: array description: A list of line items in the package. example: - sku: sku quantity: quantity items: $ref: '#/components/schemas/PackageOrderItem' required: - package_name additionalProperties: false title: PackiyoBox OrderShipmentMeasurements: type: object properties: length: type: number description: '' example: 0 width: type: number description: '' example: 0 height: type: number description: '' example: 0 unit: type: string enum: - cm - in description: The unit of measurement for the size of the order shipment. example: in weight: type: number description: '' example: 0 weight_unit: type: string enum: - kg - oz - lb description: The unit of measurement for the weight of the order shipment. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: OrderShipmentMeasurements ShipmentMeasurementsskuvault: type: object properties: weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the shipment. example: lb required: - weight - weight_unit additionalProperties: false title: ShipmentMeasurementsskuvault WmsOrderFulfillLineItemskuvault: type: object properties: sku: type: string description: '' example: sku quantity: type: integer description: '' example: 0 required: - quantity - sku additionalProperties: false title: WmsOrderFulfillLineItemskuvault OrderChannel: type: object properties: channel_id: type: string description: The ID of the channel. example: channel_id channel_name: type: - string - 'null' description: The name of the channel. example: channel_name required: - channel_id - channel_name additionalProperties: false title: OrderChannel ShipToAddress: type: object properties: full_name: type: - string - 'null' description: '' example: John Doe company: type: - string - 'null' description: '' example: Company address1: type: - string - 'null' description: '' example: 123 Main St address2: type: - string - 'null' description: '' example: Apt 2 address3: type: - string - 'null' description: '' example: Floor 3 city: type: - string - 'null' description: '' example: New York state: type: - string - 'null' description: '' example: NY postal_code: type: - string - 'null' description: '' example: '10001' country: type: - string - 'null' description: '' example: United States phone_number: type: - string - 'null' description: '' example: 123-456-7890 email_address: type: - string - 'null' description: '' example: johndoe@example.com required: - address1 - address2 - address3 - city - company - country - email_address - full_name - phone_number - postal_code - state additionalProperties: false title: ShipToAddress WmsOrderLineItem: type: object properties: product_id: type: string description: >- Can be passed into the [Product](/api-reference/wms-api/products/get-item) endpoint for more details. example: product_id sku: type: - string - 'null' description: '' example: sku quantity: type: integer description: '' example: 1 unit_price: type: - number - 'null' description: >- The price of the product in the currency specified by `invoice_currency_code`. example: 10.99 discount_amount: type: - number - 'null' description: The amount discounted from the product for this order. example: 1.5 required: - discount_amount - product_id - quantity - sku - unit_price additionalProperties: false title: WmsOrderLineItem OrderShipment: type: object properties: shipment_id: type: string description: The ID of the shipment. example: shipment_id warehouse_id: type: string description: >- The warehouse this order was shipped from. Can be passed into the [Warehouse](/api-reference/wms-api/warehouses/get-item) endpoint for more details. example: warehouse_id raw_status: type: - string - 'null' description: >- The raw status (if available) of the shipment returned directly from the WMS. example: raw_status status: type: string enum: - open - shipped - cancelled - other description: The status of the shipment. example: shipped shipped_date: type: - string - 'null' format: date-time description: The date the shipment was sent. example: '2022-05-06T01:02:03Z' line_items: type: array description: List of the inventory items listed in the shipment. items: $ref: '#/components/schemas/ShipmentLineItem' ship_to_address: $ref: '#/components/schemas/ShipToAddress' ship_from_address: $ref: '#/components/schemas/ShipFromAddress' packages: type: array description: A list of the packages included in the shipment. items: $ref: '#/components/schemas/Package' required: - line_items - packages - raw_status - ship_from_address - ship_to_address - shipment_id - shipped_date - status - warehouse_id additionalProperties: false title: OrderShipment PackageMeasurementspackiyo: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the package. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the package. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: PackageMeasurementspackiyo PackageOrderItem: type: object properties: sku: type: string description: SKU example: sku quantity: type: integer description: Quantity example: 0 required: - quantity - sku additionalProperties: false title: PackageOrderItem ShipmentLineItem: type: object properties: inventory_item_id: type: string description: >- The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. example: inventory_item_id sku: type: - string - 'null' description: '' example: sku quantity: type: integer description: '' example: 0 parent_product_id: type: - string - 'null' description: >- 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. example: parent_product_id required: - inventory_item_id - parent_product_id - quantity - sku additionalProperties: false title: ShipmentLineItem ShipFromAddress: type: object properties: address1: type: - string - 'null' description: '' example: 123 Main St address2: type: - string - 'null' description: '' example: Apt 2 address3: type: - string - 'null' description: '' example: Floor 3 city: type: - string - 'null' description: '' example: New York state: type: - string - 'null' description: '' example: NY postal_code: type: - string - 'null' description: '' example: '10001' country: type: - string - 'null' description: '' example: United States required: - address1 - address2 - address3 - city - country - postal_code - state additionalProperties: false title: ShipFromAddress Package: type: object properties: package_id: type: string description: The ID of the package. example: package_id package_name: type: - string - 'null' description: The name of the package. (e.g. 12x9x4) example: package_name tracking_number: type: - string - 'null' description: The tracking number for the package. example: tracking_number tracking_url: type: - string - 'null' description: The URL for the tracking number. example: tracking_url shipping_method_id: type: - string - 'null' description: The ID of the shipping method returned at the package level. example: shipping_method_id shipping_method_name: type: - string - 'null' description: The name of the shipping method returned at the package level. example: Standard Shipping carrier_id: type: - string - 'null' description: The ID of the carrier used to ship the package. example: carrier_id carrier_name: type: - string - 'null' description: The name of the carrier used to ship the package. example: carrier_name scac: type: - string - 'null' description: >- The Standard Carrier Alpha Code for the carrier used to ship the package. example: scac bill_of_lading: type: - string - 'null' description: The bill of lading number associated with the package's shipment. example: bill_of_lading sscc: type: - string - 'null' description: The Serial Shipping Container Code (GS1) identifying the package. example: sscc pro_number: type: - string - 'null' description: >- The PRO (freight tracking) number associated with the package's shipment. example: pro_number shipping_cost: type: - number - 'null' description: The cost incurred by the warehouse to ship the package. example: 2.5 measurements: $ref: '#/components/schemas/PackageMeasurements' line_items: type: array description: A list of the inventory items included in the package. items: $ref: '#/components/schemas/PackageLineItem' required: - bill_of_lading - carrier_id - carrier_name - line_items - measurements - package_id - package_name - pro_number - scac - shipping_cost - shipping_method_id - shipping_method_name - sscc - tracking_number - tracking_url additionalProperties: false title: Package PackageMeasurements: type: object properties: length: type: - number - 'null' description: '' example: 1.5 width: type: - number - 'null' description: '' example: 1.5 height: type: - number - 'null' description: '' example: 1.5 unit: type: - string - 'null' enum: - cm - in description: The unit of measurement for the size of the package. example: in weight: type: - number - 'null' description: '' example: 2.5 weight_unit: type: - string - 'null' enum: - kg - oz - lb description: The unit of measurement for the weight of the package. example: lb required: - height - length - unit - weight - weight_unit - width additionalProperties: false title: PackageMeasurements PackageLineItem: type: object properties: inventory_item_id: type: string description: >- The ID of the inventory item. Can be passed into the [Inventory](/api-reference/wms-api/inventory/get-item) endpoint for more details. example: inventory_item_id sku: type: - string - 'null' description: '' example: sku quantity: type: integer description: '' example: 0 lot_id: type: - string - 'null' description: The ID of the lot the inventory item was picked from. example: lot_id expiration_date: type: - string - 'null' format: date-time description: The expiration date of the lot the inventory item was picked from. example: '2023-03-15T13:45:30Z' parent_product_id: type: - string - 'null' description: >- 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. example: parent_product_id required: - expiration_date - inventory_item_id - lot_id - parent_product_id - quantity - sku additionalProperties: false title: PackageLineItem ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.