Order shipment created

Body

application/json

connection_id

string

required

Example:

"connection_id"

data

OrderSchema · object

required

Show child attributes

data.id

string

The unique ID of the order.

Example:

"order_id"

data.warehouse_customer_id

string | null

The ID of the merchant/tenant/customer that owns the order. Can be passed into the Warehouse Customer endpoint for more details.

Example:

"warehouse_customer_id"

data.warehouse_id

string | null

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 endpoint for more details.

Example:

"warehouse_id"

data.created_date

string<date-time>

The date the order was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string<date-time>

The date the order was last updated.

Example:

"2022-01-02T05:05:05Z"

data.reference_id

string

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"

data.order_number

string

A user-friendly identifier for their order. Defaults to reference_id if not provided.

Example:

"order_number"

data.status

enum<string>

The status of the order. See the order information for more details.

Available options:

open,

confirmed,

processing,

picked,

packed,

partially_fulfilled,

fulfilled,

exception,

cancelled,

backordered,

other

Example:

"open"

data.raw_status

string | null

The raw status (if available) returned directly from the WMS.

Example:

"raw_status"

data.channel

string | null

Deprecated in favor of channel_object.

Example:

"channel_id"

data.channel_object

OrderChannel · object

Show child attributes

data.channel_object.channel_id

string

required

The ID of the channel.

Example:

"channel_id"

data.channel_object.channel_name

string | null

required

The name of the channel.

Example:

"channel_name"

data.type

enum<string> | null

The type of order, such as d2c, b2b, dropship, or transfer.

Available options:

d2c,

b2b,

dropship,

transfer

Example:

"d2c"

data.trading_partner

string | null

For retail/EDI orders, the trading partner who placed the order (e.g. Target, Walmart).

Example:

"Target"

data.shipping_method

string | null

Deprecated.

data.service_level

string | null

The type of shipping method requested by the customer.

Example:

"Standard"

data.shipping_method_id

string | null

The ID of the actual shipping method used to ship the order. Can be passed into the Shipping Method endpoint for more details.. May vary from the shipping methods returned at the package level.

Example:

"fedex_ground"

data.shipping_method_name

string | null

The name of the shipping method used to ship the order.

Example:

"FedEx Ground"

data.carrier_id

string | null

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"

data.carrier_name

string | null

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"

data.scac

string | null

The Standard Carrier Alpha Code for the carrier used to ship the order.

data.is_third_party_freight

boolean | null

True if the order was shipped using a third party freight account.

Example:

false

data.third_party_freight_account_number

string | null

The third party freight account number used to ship the order.

Example:

"123456"

data.first_party_freight_account_number

string | null

The first party freight account number used to ship the order.

Example:

"123456"

data.invoice_currency_code

string

The currency used for this order. If not provided explicitly, defaults to USD.

Example:

"USD"

data.total_price

number | null

The total price a customer paid for the order.

Example:

13.49

data.total_tax

number | null

The total tax on the order.

Example:

1.5

data.total_discount

number | null

The total amount discounted from the order.

Example:

2.5

data.total_shipping

number | null

The total shipping cost for the order incurred by the customer.

Example:

3.5

data.ship_to_address

ShipToAddress · object

Show child attributes

data.ship_to_address.full_name

string | null

required

Example:

"John Doe"

data.ship_to_address.company

string | null

required

Example:

"Company"

data.ship_to_address.address1

string | null

required

Example:

"123 Main St"

data.ship_to_address.address2

string | null

required

Example:

"Apt 2"

data.ship_to_address.address3

string | null

required

Example:

"Floor 3"

data.ship_to_address.city

string | null

required

Example:

"New York"

data.ship_to_address.state

string | null

required

Example:

"NY"

data.ship_to_address.postal_code

string | null

required

Example:

"10001"

data.ship_to_address.country

string | null

required

Example:

"United States"

data.ship_to_address.phone_number

string | null

required

Example:

"123-456-7890"

data.ship_to_address.email_address

string | null

required

Example:

"[email protected]"

data.line_items

WmsOrderLineItem · object[]

List of the products included in the order.

Show child attributes

data.line_items.product_id

string

required

Can be passed into the Product endpoint for more details.

Example:

"product_id"

data.line_items.sku

string | null

required

Example:

"sku"

data.line_items.quantity

integer

required

Example:

1

data.line_items.unit_price

number | null

required

The price of the product in the currency specified by invoice_currency_code.

Example:

10.99

data.line_items.is_picked

boolean

required

Whether the product has been picked in the warehouse.

Example:

false

data.line_items.discount_amount

number | null

required

The amount discounted from the product for this order.

Example:

1.5

Example:

[
  {
    "product_id": "product_id",
    "sku": "sku",
    "quantity": 1,
    "unit_price": 10.99,
    "is_picked": false,
    "discount_amount": 1.5
  }
]

data.tags

string[]

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.

A tag associated with the order.

Example:

["tag_0"]

data.required_ship_date

string<date-time> | null

The date the order must be shipped by.

Example:

"2021-01-01T12:00:00Z"

data.saturday_delivery

boolean | null

True if the order requires Saturday delivery.

Example:

false

data.signature_required

boolean | null

True if the order requires a signature upon delivery.

Example:

false

data.international_duty_paid_by

enum<string> | null

The party responsible for paying international duties.

Available options:

sender,

recipient,

third_party

Example:

"sender"

data.shipments

OrderShipment · object[]

List of the shipments sent out to the customer.

Show child attributes

data.shipments.shipment_id

string

required

The ID of the shipment.

data.shipments.warehouse_id

string

required

The warehouse this order was shipped from. Can be passed into the Warehouse endpoint for more details.

data.shipments.raw_status

string | null

required

The raw status (if available) of the shipment returned directly from the WMS.

Example:

"raw_status"

data.shipments.status

enum<string>

required

The status of the shipment.

Available options:

open,

shipped,

cancelled,

other

Example:

"shipped"

data.shipments.shipped_date

string<date-time> | null

required

The date the shipment was sent.

Example:

"2022-05-06T01:02:03Z"

data.shipments.shipping_method

string | null

required

Deprecated.

data.shipments.line_items

ShipmentLineItem · object[]

required

List of the inventory items listed in the shipment.

Show child attributes

data.shipments.line_items.inventory_item_id

string

required

The ID of the inventory item. Can be passed into the Inventory endpoint for more details.

data.shipments.line_items.sku

string | null

required

data.shipments.line_items.quantity

integer

required

Example:

0

data.shipments.line_items.parent_product_id

string | null

required

The ID of the parent product if the line item is part of a kit. Can be passed into the Product endpoint for more details.

data.shipments.ship_to_address

ShipToAddress · object

required

Show child attributes

data.shipments.ship_to_address.full_name

string | null

required

Example:

"John Doe"

data.shipments.ship_to_address.company

string | null

required

Example:

"Company"

data.shipments.ship_to_address.address1

string | null

required

Example:

"123 Main St"

data.shipments.ship_to_address.address2

string | null

required

Example:

"Apt 2"

data.shipments.ship_to_address.address3

string | null

required

Example:

"Floor 3"

data.shipments.ship_to_address.city

string | null

required

Example:

"New York"

data.shipments.ship_to_address.state

string | null

required

Example:

"NY"

data.shipments.ship_to_address.postal_code

string | null

required

Example:

"10001"

data.shipments.ship_to_address.country

string | null

required

Example:

"United States"

data.shipments.ship_to_address.phone_number

string | null

required

Example:

"123-456-7890"

data.shipments.ship_to_address.email_address

string | null

required

Example:

"[email protected]"

data.shipments.ship_from_address

ShipFromAddress · object

required

Show child attributes

data.shipments.ship_from_address.address1

string | null

required

Example:

"123 Main St"

data.shipments.ship_from_address.address2

string | null

required

Example:

"Apt 2"

data.shipments.ship_from_address.address3

string | null

required

Example:

"Floor 3"

data.shipments.ship_from_address.city

string | null

required

Example:

"New York"

data.shipments.ship_from_address.state

string | null

required

Example:

"NY"

data.shipments.ship_from_address.postal_code

string | null

required

Example:

"10001"

data.shipments.ship_from_address.country

string | null

required

Example:

"United States"

data.shipments.packages

Package · object[]

required

A list of the packages included in the shipment.

Show child attributes

data.shipments.packages.package_id

string

required

The ID of the package.

data.shipments.packages.package_name

string | null

required

The name of the package. (e.g. 12x9x4)

data.shipments.packages.tracking_number

string | null

required

The tracking number for the package.

data.shipments.packages.tracking_url

string | null

required

The URL for the tracking number.

data.shipments.packages.shipping_method

string | null

required

Deprecated.

data.shipments.packages.carrier

string | null

required

Deprecated.

data.shipments.packages.shipping_method_id

string | null

required

The ID of the shipping method returned at the package level.

Example:

"shipping_method_id"

data.shipments.packages.shipping_method_name

string | null

required

The name of the shipping method returned at the package level.

Example:

"Standard Shipping"

data.shipments.packages.carrier_id

string | null

required

The ID of the carrier used to ship the package.

Example:

"carrier_id"

data.shipments.packages.carrier_name

string | null

required

The name of the carrier used to ship the package.

Example:

"carrier_name"

data.shipments.packages.scac

string | null

required

The Standard Carrier Alpha Code for the carrier used to ship the package.

data.shipments.packages.shipping_cost

number | null

required

The cost incurred by the warehouse to ship the package.

Example:

2.5

data.shipments.packages.measurements

PackageMeasurements · object

required

Show child attributes

data.shipments.packages.measurements.length

number | null

required

Example:

1.5

data.shipments.packages.measurements.width

number | null

required

Example:

1.5

data.shipments.packages.measurements.height

number | null

required

Example:

1.5

data.shipments.packages.measurements.unit

enum<string> | null

required

The unit of measurement for the size of the package.

Available options:

cm,

in

Example:

"in"

data.shipments.packages.measurements.weight

number | null

required

Example:

2.5

data.shipments.packages.measurements.weight_unit

enum<string> | null

required

The unit of measurement for the weight of the package.

Available options:

kg,

oz,

lb

Example:

"lb"

data.shipments.packages.line_items

PackageLineItem · object[]

required

A list of the inventory items included in the package.

Show child attributes

data.shipments.packages.line_items.inventory_item_id

string

required

The ID of the inventory item. Can be passed into the Inventory endpoint for more details.

data.shipments.packages.line_items.sku

string | null

required

data.shipments.packages.line_items.quantity

integer

required

Example:

0

data.shipments.packages.line_items.lot_id

string | null

required

The ID of the lot the inventory item was picked from.

data.shipments.packages.line_items.expiration_date

string<date-time> | null

required

The expiration date of the lot the inventory item was picked from.

data.shipments.packages.line_items.parent_product_id

string | null

required

The ID of the parent product if the line item is part of a kit. Can be passed into the Product endpoint for more details.

Example:

[
  {
    "shipment_id": "shipment_id",
    "warehouse_id": "wh_id",
    "shipped_date": "2022-05-06T01:02:03Z",
    "raw_status": "raw_status",
    "status": "shipped",
    "shipping_method": "shipping_method_id",
    "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": "shipping_method_id",
        "carrier": "carrier",
        "shipping_method_id": "shipping_method_id",
        "shipping_method_name": "shipping_method_name",
        "carrier_id": "carrier_id",
        "carrier_name": "carrier_name",
        "scac": "scac",
        "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
          }
        ]
      }
    ]
  }
]

data.external_system_url

string | null

URL link to the order in the external system (WMS/Freight etc).

Example:

"https://example.com/order/123"

data.trackstar_tags

any[] | null

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" }]

data.additional_fields

object

Integration-specific fields

Show child attributes

data.additional_fields.{key}

any

Example:

{ "key": "value" }

event_type

string

required

Example:

"order.shipment.created"

integration_name

string

required

Example:

"integration_name"

integration_type

string

required

Example:

"wms"

previous_attributes

object

required

Show child attributes

previous_attributes.shipments

OrderShipment · object[]

List of the shipments sent out to the customer.

Show child attributes

previous_attributes.shipments.shipment_id

string

required

The ID of the shipment.

previous_attributes.shipments.warehouse_id

string

required

The warehouse this order was shipped from. Can be passed into the Warehouse endpoint for more details.

previous_attributes.shipments.raw_status

string | null

required

The raw status (if available) of the shipment returned directly from the WMS.

Example:

"raw_status"

previous_attributes.shipments.status

enum<string>

required

The status of the shipment.

Available options:

open,

shipped,

cancelled,

other

Example:

"shipped"

previous_attributes.shipments.shipped_date

string<date-time> | null

required

The date the shipment was sent.

Example:

"2022-05-06T01:02:03Z"

previous_attributes.shipments.shipping_method

string | null

required

Deprecated.

previous_attributes.shipments.line_items

ShipmentLineItem · object[]

required

List of the inventory items listed in the shipment.

Show child attributes

previous_attributes.shipments.line_items.inventory_item_id

string

required

The ID of the inventory item. Can be passed into the Inventory endpoint for more details.

previous_attributes.shipments.line_items.sku

string | null

required

previous_attributes.shipments.line_items.quantity

integer

required

Example:

0

previous_attributes.shipments.line_items.parent_product_id

string | null

required

The ID of the parent product if the line item is part of a kit. Can be passed into the Product endpoint for more details.

previous_attributes.shipments.ship_to_address

ShipToAddress · object

required

Show child attributes

previous_attributes.shipments.ship_to_address.full_name

string | null

required

Example:

"John Doe"

previous_attributes.shipments.ship_to_address.company

string | null

required

Example:

"Company"

previous_attributes.shipments.ship_to_address.address1

string | null

required

Example:

"123 Main St"

previous_attributes.shipments.ship_to_address.address2

string | null

required

Example:

"Apt 2"

previous_attributes.shipments.ship_to_address.address3

string | null

required

Example:

"Floor 3"

previous_attributes.shipments.ship_to_address.city

string | null

required

Example:

"New York"

previous_attributes.shipments.ship_to_address.state

string | null

required

Example:

"NY"

previous_attributes.shipments.ship_to_address.postal_code

string | null

required

Example:

"10001"

previous_attributes.shipments.ship_to_address.country

string | null

required

Example:

"United States"

previous_attributes.shipments.ship_to_address.phone_number

string | null

required

Example:

"123-456-7890"

previous_attributes.shipments.ship_to_address.email_address

string | null

required

Example:

"[email protected]"

previous_attributes.shipments.ship_from_address

ShipFromAddress · object

required

Show child attributes

previous_attributes.shipments.ship_from_address.address1

string | null

required

Example:

"123 Main St"

previous_attributes.shipments.ship_from_address.address2

string | null

required

Example:

"Apt 2"

previous_attributes.shipments.ship_from_address.address3

string | null

required

Example:

"Floor 3"

previous_attributes.shipments.ship_from_address.city

string | null

required

Example:

"New York"

previous_attributes.shipments.ship_from_address.state

string | null

required

Example:

"NY"

previous_attributes.shipments.ship_from_address.postal_code

string | null

required

Example:

"10001"

previous_attributes.shipments.ship_from_address.country

string | null

required

Example:

"United States"

previous_attributes.shipments.packages

Package · object[]

required

A list of the packages included in the shipment.

Show child attributes

previous_attributes.shipments.packages.package_id

string

required

The ID of the package.

previous_attributes.shipments.packages.package_name

string | null

required

The name of the package. (e.g. 12x9x4)

previous_attributes.shipments.packages.tracking_number

string | null

required

The tracking number for the package.

previous_attributes.shipments.packages.tracking_url

string | null

required

The URL for the tracking number.

previous_attributes.shipments.packages.shipping_method

string | null

required

Deprecated.

previous_attributes.shipments.packages.carrier

string | null

required

Deprecated.

previous_attributes.shipments.packages.shipping_method_id

string | null

required

The ID of the shipping method returned at the package level.

Example:

"shipping_method_id"

previous_attributes.shipments.packages.shipping_method_name

string | null

required

The name of the shipping method returned at the package level.

Example:

"Standard Shipping"

previous_attributes.shipments.packages.carrier_id

string | null

required

The ID of the carrier used to ship the package.

Example:

"carrier_id"

previous_attributes.shipments.packages.carrier_name

string | null

required

The name of the carrier used to ship the package.

Example:

"carrier_name"

previous_attributes.shipments.packages.scac

string | null

required

The Standard Carrier Alpha Code for the carrier used to ship the package.

previous_attributes.shipments.packages.shipping_cost

number | null

required

The cost incurred by the warehouse to ship the package.

Example:

2.5

previous_attributes.shipments.packages.measurements

PackageMeasurements · object

required

Show child attributes

previous_attributes.shipments.packages.measurements.length

number | null

required

Example:

1.5

previous_attributes.shipments.packages.measurements.width

number | null

required

Example:

1.5

previous_attributes.shipments.packages.measurements.height

number | null

required

Example:

1.5

previous_attributes.shipments.packages.measurements.unit

enum<string> | null

required

The unit of measurement for the size of the package.

Available options:

cm,

in

Example:

"in"

previous_attributes.shipments.packages.measurements.weight

number | null

required

Example:

2.5

previous_attributes.shipments.packages.measurements.weight_unit

enum<string> | null

required

The unit of measurement for the weight of the package.

Available options:

kg,

oz,

lb

Example:

"lb"

previous_attributes.shipments.packages.line_items

PackageLineItem · object[]

required

A list of the inventory items included in the package.

Show child attributes

previous_attributes.shipments.packages.line_items.inventory_item_id

string

required

The ID of the inventory item. Can be passed into the Inventory endpoint for more details.

previous_attributes.shipments.packages.line_items.sku

string | null

required

previous_attributes.shipments.packages.line_items.quantity

integer

required

Example:

0

previous_attributes.shipments.packages.line_items.lot_id

string | null

required

The ID of the lot the inventory item was picked from.

previous_attributes.shipments.packages.line_items.expiration_date

string<date-time> | null

required

The expiration date of the lot the inventory item was picked from.

previous_attributes.shipments.packages.line_items.parent_product_id

string | null

required

The ID of the parent product if the line item is part of a kit. Can be passed into the Product endpoint for more details.

Example:

[
  {
    "shipment_id": "shipment_id",
    "warehouse_id": "wh_id",
    "shipped_date": "2022-05-06T01:02:03Z",
    "raw_status": "raw_status",
    "status": "shipped",
    "shipping_method": "shipping_method_id",
    "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": "shipping_method_id",
        "carrier": "carrier",
        "shipping_method_id": "shipping_method_id",
        "shipping_method_name": "shipping_method_name",
        "carrier_id": "carrier_id",
        "carrier_name": "carrier_name",
        "scac": "scac",
        "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
          }
        ]
      }
    ]
  }
]

Response

200

Success

Home

How-To Guides

Use Cases

Order shipment created

Body

Response