Create Cart Order Shipment

curl --request POST \
  --url https://production.trackstarhq.com/cart/orders/{order_id}/shipments \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '
{
  "tracking_number": "<string>",
  "tracking_url": "https://www.example.com/tracking",
  "carrier_name": "Carrier Name",
  "requested_shipping_method": "Standard"
}
'

{
  "data": {
    "id": "order_id",
    "order_number": "order_number",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "status": "fulfilled",
    "raw_status": "raw_status",
    "requested_shipping_method": "Standard",
    "shipping_method_id": "shipping_method_id",
    "shipping_method_name": "Standard Shipping",
    "carrier_id": "carrier_id",
    "carrier_name": "Carrier Name",
    "invoice_currency_code": "USD",
    "total_price": 13.49,
    "total_tax": 1.5,
    "total_discount": 2.5,
    "total_shipping": 3.5,
    "ship_to_address": {
      "full_name": "John Doe",
      "company": "Company",
      "address1": "123 Main St",
      "address2": "Apt 2",
      "address3": "Floor 3",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "United States",
      "phone_number": "123-456-7890",
      "email_address": "[email protected]"
    },
    "bill_to_address": {
      "full_name": "John Doe",
      "address1": "123 Main St",
      "address2": "Apt 2",
      "address3": "Floor 3",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "United States"
    },
    "earliest_ship_date": "2022-10-10T01:02:03Z",
    "latest_ship_date": "2022-10-10T01:02:03Z",
    "line_items": [
      {
        "line_item_id": "line_item_id",
        "product_id": null,
        "product_sku": null,
        "parent_product_id": null,
        "parent_product_sku": null,
        "quantity": 1,
        "unit_price": 10.99,
        "discount": 1.5,
        "tax": 0.5
      }
    ],
    "shipping_groups": [
      {
        "shipping_group_id": "shipping_group_id",
        "created_date": "2022-01-01T00:00:00Z",
        "updated_date": "2022-01-02T05:05:05Z",
        "raw_status": "raw_status",
        "status": "shipped",
        "warehouse_id": "warehouse_id",
        "line_items": [
          {
            "line_item_id": "shipping_group_line_item_id",
            "product_id": "<string>",
            "product_sku": "<string>",
            "parent_product_id": "<string>",
            "quantity": 0
          }
        ]
      }
    ],
    "shipments": [
      {
        "shipment_id": "shipment_id",
        "raw_status": "raw_status",
        "status": "shipped",
        "warehouse_id": "warehouse_id",
        "shipping_method_id": "shipment_shipping_method_id",
        "shipping_method_name": "shipment_shipping_method_name",
        "carrier_id": "carrier_id",
        "carrier_name": "carrier_name",
        "tracking_number": "<string>",
        "tracking_url": "https://www.example.com/tracking",
        "line_items": [
          {
            "shipment_line_item_id": "<string>",
            "product_id": "<string>",
            "product_sku": "<string>",
            "parent_product_id": "<string>",
            "parent_product_sku": "<string>",
            "quantity": 0
          }
        ],
        "shipping_groups": [
          "sg_id_1",
          "sg_id_2"
        ],
        "created_date": "2022-01-01T00:00:00Z",
        "updated_date": "2022-01-02T05:05:05Z"
      }
    ],
    "external_system_url": "https://example.com/order/123",
    "additional_fields": {
      "key": "value"
    }
  },
  "id": "id",
  "unused_fields": [
    "<string>"
  ]
}

POST

cart

orders

{order_id}

shipments

Create Cart Order Shipment

curl --request POST \
  --url https://production.trackstarhq.com/cart/orders/{order_id}/shipments \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '
{
  "tracking_number": "<string>",
  "tracking_url": "https://www.example.com/tracking",
  "carrier_name": "Carrier Name",
  "requested_shipping_method": "Standard"
}
'

{
  "data": {
    "id": "order_id",
    "order_number": "order_number",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "status": "fulfilled",
    "raw_status": "raw_status",
    "requested_shipping_method": "Standard",
    "shipping_method_id": "shipping_method_id",
    "shipping_method_name": "Standard Shipping",
    "carrier_id": "carrier_id",
    "carrier_name": "Carrier Name",
    "invoice_currency_code": "USD",
    "total_price": 13.49,
    "total_tax": 1.5,
    "total_discount": 2.5,
    "total_shipping": 3.5,
    "ship_to_address": {
      "full_name": "John Doe",
      "company": "Company",
      "address1": "123 Main St",
      "address2": "Apt 2",
      "address3": "Floor 3",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "United States",
      "phone_number": "123-456-7890",
      "email_address": "[email protected]"
    },
    "bill_to_address": {
      "full_name": "John Doe",
      "address1": "123 Main St",
      "address2": "Apt 2",
      "address3": "Floor 3",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "United States"
    },
    "earliest_ship_date": "2022-10-10T01:02:03Z",
    "latest_ship_date": "2022-10-10T01:02:03Z",
    "line_items": [
      {
        "line_item_id": "line_item_id",
        "product_id": null,
        "product_sku": null,
        "parent_product_id": null,
        "parent_product_sku": null,
        "quantity": 1,
        "unit_price": 10.99,
        "discount": 1.5,
        "tax": 0.5
      }
    ],
    "shipping_groups": [
      {
        "shipping_group_id": "shipping_group_id",
        "created_date": "2022-01-01T00:00:00Z",
        "updated_date": "2022-01-02T05:05:05Z",
        "raw_status": "raw_status",
        "status": "shipped",
        "warehouse_id": "warehouse_id",
        "line_items": [
          {
            "line_item_id": "shipping_group_line_item_id",
            "product_id": "<string>",
            "product_sku": "<string>",
            "parent_product_id": "<string>",
            "quantity": 0
          }
        ]
      }
    ],
    "shipments": [
      {
        "shipment_id": "shipment_id",
        "raw_status": "raw_status",
        "status": "shipped",
        "warehouse_id": "warehouse_id",
        "shipping_method_id": "shipment_shipping_method_id",
        "shipping_method_name": "shipment_shipping_method_name",
        "carrier_id": "carrier_id",
        "carrier_name": "carrier_name",
        "tracking_number": "<string>",
        "tracking_url": "https://www.example.com/tracking",
        "line_items": [
          {
            "shipment_line_item_id": "<string>",
            "product_id": "<string>",
            "product_sku": "<string>",
            "parent_product_id": "<string>",
            "parent_product_sku": "<string>",
            "quantity": 0
          }
        ],
        "shipping_groups": [
          "sg_id_1",
          "sg_id_2"
        ],
        "created_date": "2022-01-01T00:00:00Z",
        "updated_date": "2022-01-02T05:05:05Z"
      }
    ],
    "external_system_url": "https://example.com/order/123",
    "additional_fields": {
      "key": "value"
    }
  },
  "id": "id",
  "unused_fields": [
    "<string>"
  ]
}

Headers

x-trackstar-api-key

string

required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

x-trackstar-access-token

string

required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Example:

"<x-trackstar-access-token>"

Path Parameters

order_id

string

required

Body

application/json

tracking_number

string

The tracking number for the shipment.

tracking_url

string

The URL for the tracking number.

Example:

"https://www.example.com/tracking"

carrier_name

string

The name of the carrier used to ship the order.

Example:

"Carrier Name"

requested_shipping_method

string

The type of shipping method requested by the customer.

Example:

"Standard"

Response

Successful response

data

CreateCartOrderShipmentResponseDataSchema · object

Show child attributes

data.id

string

The unique ID of the order.

Example:

"order_id"

data.order_number

string

The order number assigned by the platform. Defaults to order ID.

Example:

"order_number"

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.status

enum<string>

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

Available options:

open,

confirmed,

processing,

partially_fulfilled,

fulfilled,

exception,

cancelled,

backordered,

other

Example:

"fulfilled"

data.raw_status

string | null

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

Example:

"raw_status"

data.requested_shipping_method

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.

Example:

"shipping_method_id"

data.shipping_method_name

string | null

The name of the shipping method.

Example:

"Standard Shipping"

data.carrier_id

string | null

The ID of the carrier used to ship the order.

Example:

"carrier_id"

data.carrier_name

string | null

The name of the carrier used to ship the order.

Example:

"Carrier Name"

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.bill_to_address

BillToAddress · object

Show child attributes

data.bill_to_address.full_name

string | null

required

Example:

"John Doe"

data.bill_to_address.address1

string | null

required

Example:

"123 Main St"

data.bill_to_address.address2

string | null

required

Example:

"Apt 2"

data.bill_to_address.address3

string | null

required

Example:

"Floor 3"

data.bill_to_address.city

string | null

required

Example:

"New York"

data.bill_to_address.state

string | null

required

Example:

"NY"

data.bill_to_address.postal_code

string | null

required

Example:

"10001"

data.bill_to_address.country

string | null

required

Example:

"United States"

data.earliest_ship_date

string<date-time> | null

The earliest date the order can be shipped.

Example:

"2022-10-10T01:02:03Z"

data.latest_ship_date

string<date-time> | null

The latest date the order can be shipped.

Example:

"2022-10-10T01:02:03Z"

data.line_items

CartOrderLineItem · object[]

List of the products included in the order.

Show child attributes

data.line_items.line_item_id

string

required

The ID of the line item.

Example:

"line_item_id"

data.line_items.product_id

string

required

The ID of the product. Can be passed into the Cart Product endpoint for more details.

data.line_items.product_sku

string | null

required

data.line_items.parent_product_id

string | null

required

The ID of the product's parent.

data.line_items.parent_product_sku

string | null

required

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.discount

number | null

required

The unit amount discounted from the product for this order. This is the amount of discount per unit of the product.

Example:

1.5

data.line_items.tax

number | null

required

The unit amount of tax on the product for this order. This is the amount of tax per unit of the product

Example:

0.5

Example:

[
  {
    "line_item_id": "line_item_id",
    "product_id": null,
    "product_sku": null,
    "parent_product_id": null,
    "parent_product_sku": null,
    "quantity": 1,
    "unit_price": 10.99,
    "discount": 1.5,
    "tax": 0.5
  }
]

data.shipping_groups

CartOrderShippingGroup · object[]

Sets of line items that will be fulfilled together from the same locations. Only applies in Shopify, as fulfillmentOrders.

Show child attributes

data.shipping_groups.shipping_group_id

string

required

The ID of the shipping_group.

Example:

"shipping_group_id"

data.shipping_groups.created_date

string<date-time>

required

The date the shipping_group was created.

Example:

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

data.shipping_groups.updated_date

string<date-time>

required

The date the shipping_group was last updated.

Example:

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

data.shipping_groups.raw_status

string | null

required

The raw status (if available) of the shipping group returned directly from the integration.

Example:

"raw_status"

data.shipping_groups.status

enum<string> | null

required

The status of the shipping group.

Available options:

open,

shipped,

delivered,

cancelled,

exception,

on_hold,

other

Example:

"shipped"

data.shipping_groups.warehouse_id

string

required

The ID of the warehouse that the shipping group will send from. Subject to change.

Example:

"warehouse_id"

data.shipping_groups.line_items

CartOrderShipmentGroupLineItem · object[]

required

List of the products in the shipping group.

Show child attributes

data.shipping_groups.line_items.line_item_id

string

required

The ID of the line item in the shipping group.

Example:

"shipping_group_line_item_id"

data.shipping_groups.line_items.product_id

string

required

The ID of the product.

data.shipping_groups.line_items.product_sku

string | null

required

data.shipping_groups.line_items.parent_product_id

string | null

required

The ID of the product's parent.

data.shipping_groups.line_items.quantity

integer

required

Example:

0

data.shipments

CartOrderShipment · object[]

List of the shipments sent out to the customer.

Show child attributes

data.shipments.shipment_id

string

required

The ID of the shipment.

Example:

"shipment_id"

data.shipments.raw_status

string | null

required

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

Example:

"raw_status"

data.shipments.status

enum<string> | null

required

The status of the shipment.

Available options:

open,

shipped,

delivered,

cancelled,

exception,

on_hold,

other

Example:

"shipped"

data.shipments.warehouse_id

string | null

required

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

Example:

"warehouse_id"

data.shipments.shipping_method_id

string | null

required

The ID of the shipping method used for the shipment.

Example:

"shipment_shipping_method_id"

data.shipments.shipping_method_name

string | null

required

The name of the shipping method used for the shipment.

Example:

"shipment_shipping_method_name"

data.shipments.carrier_id

string | null

required

The ID of the carrier used to ship the shipment.

Example:

"carrier_id"

data.shipments.carrier_name

string | null

required

The name of the carrier used to ship the shipment.

Example:

"carrier_name"

data.shipments.tracking_number

string | null

required

The tracking number for the shipment.

data.shipments.tracking_url

string | null

required

The URL for the tracking number.

Example:

"https://www.example.com/tracking"

data.shipments.line_items

CartOrderShipmentLineItem · object[]

required

List of the products listed in the shipment.

Show child attributes

data.shipments.line_items.shipment_line_item_id

string

required

The ID of the line item in the shipment.

data.shipments.line_items.product_id

string

required

The ID of the product.

data.shipments.line_items.product_sku

string | null

required

data.shipments.line_items.parent_product_id

string | null

required

The ID of the product's parent.

data.shipments.line_items.parent_product_sku

string | null

required

data.shipments.line_items.quantity

integer

required

Example:

0

data.shipments.shipping_groups

string[]

required

List of the shipping groups included in the shipment. Only applies in Shopify, as fulfillmentOrders.

The ID of the shipping group included in the shipment.

Example:

["sg_id_1", "sg_id_2"]

data.shipments.created_date

string<date-time> | null

required

The date the shipment was created.

Example:

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

data.shipments.updated_date

string<date-time> | null

required

The date the shipment was last updated.

Example:

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

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.additional_fields

object

Integration-specific fields

Show child attributes

data.additional_fields.{key}

any

Example:

{ "key": "value" }

string

The ID of the object that has been created or modified

Example:

"id"

unused_fields

string[]

Unused fields

Get Cart Order Warehouses

⌘I

Cart API Reference

Headers

Path Parameters

Body

Response