Create Cart Order Shipment

POST

cart

orders

{order_id}

shipments

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": "",
  "tracking_url": "https://www.example.com/tracking",
  "carrier": "carrier_name",
  "shipping_method": "shipping_method_id"
}'

{
  "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",
    "shipping_method": "shipping_method_id",
    "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"
    },
    "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"
    },
    "line_items": [
      {
        "line_item_id": "line_item_id",
        "product_id": "",
        "product_sku": "",
        "parent_product_id": "",
        "parent_product_sku": "",
        "quantity": 1,
        "unit_price": 10.99,
        "discount": 1.5,
        "tax": 0.5
      }
    ],
    "shipping_groups": [
      {
        "shipping_group_id": "shipping_group_id",
        "line_items": [
          {
            "line_item_id": "shipping_group_line_item_id",
            "product_id": "",
            "product_sku": "",
            "parent_product_id": "",
            "quantity": 0
          }
        ]
      }
    ],
    "shipments": [
      {
        "shipment_id": "shipment_id",
        "carrier": "carrier_name",
        "shipping_method": "shipping_method_id",
        "tracking_number": "",
        "tracking_url": "https://www.example.com/tracking",
        "line_items": [
          {
            "product_id": "",
            "product_sku": "",
            "parent_product_id": "",
            "parent_product_sku": "",
            "quantity": 0
          }
        ]
      }
    ],
    "external_system_url": "https://example.com/order/123"
  },
  "id": "id",
  "unused_fields": [
    ""
  ]
}

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.

Example:

""

tracking_url

string

The URL for the tracking number.

Example:

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

carrier

string

The carrier used to ship the order to the customer.

Example:

"carrier_name"

shipping_method

string

The method by which the carrier will ship the order to the customer.

Example:

"shipping_method_id"

Response

200

application/json

Successful response

data

object

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

The date the order was created.

Example:

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

data.updated_date

string

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

string | null

The method by which the carrier will ship the order to the customer.

Example:

"shipping_method_id"

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

object

data.bill_to_address

object

data.line_items

object[]

List of the products included in the order.

Example:

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

data.shipping_groups

object[]

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

data.shipments

object[]

List of the shipments sent out to the customer.

data.external_system_url

string | null

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

Example:

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

string

The ID of the object that has been created or modified

Example:

"id"

unused_fields

string[]

Unused fields

Get Cart Order

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": "",
  "tracking_url": "https://www.example.com/tracking",
  "carrier": "carrier_name",
  "shipping_method": "shipping_method_id"
}'

{
  "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",
    "shipping_method": "shipping_method_id",
    "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"
    },
    "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"
    },
    "line_items": [
      {
        "line_item_id": "line_item_id",
        "product_id": "",
        "product_sku": "",
        "parent_product_id": "",
        "parent_product_sku": "",
        "quantity": 1,
        "unit_price": 10.99,
        "discount": 1.5,
        "tax": 0.5
      }
    ],
    "shipping_groups": [
      {
        "shipping_group_id": "shipping_group_id",
        "line_items": [
          {
            "line_item_id": "shipping_group_line_item_id",
            "product_id": "",
            "product_sku": "",
            "parent_product_id": "",
            "quantity": 0
          }
        ]
      }
    ],
    "shipments": [
      {
        "shipment_id": "shipment_id",
        "carrier": "carrier_name",
        "shipping_method": "shipping_method_id",
        "tracking_number": "",
        "tracking_url": "https://www.example.com/tracking",
        "line_items": [
          {
            "product_id": "",
            "product_sku": "",
            "parent_product_id": "",
            "parent_product_sku": "",
            "quantity": 0
          }
        ]
      }
    ],
    "external_system_url": "https://example.com/order/123"
  },
  "id": "id",
  "unused_fields": [
    ""
  ]
}

Cart API Reference

Headers

Path Parameters

Body

Response