Create Order

POST

wms

orders

Header

Body

curl --request POST \
  --url https://production.trackstarhq.com/wms/orders \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '{
  "field1": "some_value",
  "field2": {
    "key": "value"
  }
}'

{
  "data": {
    "id": "order_id",
    "warehouse_customer_id": "warehouse_customer_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "reference_id": "order_reference_id",
    "order_number": "order_number",
    "status": "open",
    "channel": "channel_id",
    "trading_partner": "Target",
    "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"
    },
    "line_items": [],
    "shipments": [
      {
        "shipment_id": "shipment_id",
        "warehouse_id": "wh_id",
        "shipped_date": "2022-05-06T01:02:03Z",
        "line_items": [
          {
            "inventory_item_id": "item_id",
            "sku": "sku",
            "quantity": 1
          }
        ],
        "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": [
          {
            "tracking_number": "tracking_number",
            "tracking_url": "tracking_url",
            "carrier": "carrier",
            "scac": "scac",
            "shipping_cost": 1,
            "measurements": {
              "length": 1,
              "width": 1,
              "height": 1,
              "unit": "in",
              "weight": 1,
              "weight_unit": "lb"
            },
            "boxes": [
              {
                "box_id": "box_id",
                "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"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Headers

x-trackstar-api-key

string

required

Your organization-level Trackstar API key.

x-trackstar-access-token

string

required

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

Body

application/json

field1

string

Placeholder - variable based on integration. Read about the meta endpoint for more information.

field2

object

Placeholder - variable based on integration. Read about the meta endpoint for more information.

Response

200 - application/json

data

object

data.id

string

The unique ID of the order.

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.

data.created_date

string

The date the order was created. (Format: %Y-%m-%dT%H:%M:%SZ)

data.updated_date

string

The date the order was last updated. (Format: %Y-%m-%dT%H:%M:%SZ)

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.

data.order_number

string

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

data.status

enum<string>

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

Available options:

open,

confirmed,

processing,

allocated,

fulfilled,

exception,

cancelled

data.channel

string | null

The channel the order was placed through, such as Shopify or wholesale.

data.trading_partner

string | null

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

data.shipping_method

string | null

The method by which the warehouse will ship the order to the customer. Can be passed into the Shipping Method endpoint for more details.

data.invoice_currency_code

string

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

data.total_price

number | null

The total price a customer paid for the order.

data.total_tax

number | null

The total tax on the order.

data.total_discount

number | null

The total amount discounted from the order.

data.total_shipping

number | null

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

data.ship_to_address

object

data.line_items

object[]

List of the products included in the order.

data.shipments

object[]

List of the shipments sent out to the customer.

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

string

required

The date the shipment was sent. (Format: %Y-%m-%dT%H:%M:%SZ)

data.shipments.line_items

object[]

required

List of the inventory items listed in the shipment.

data.shipments.ship_to_address

object

required

data.shipments.ship_from_address

object

required

data.shipments.packages

object[]

required

A list of the packages included in the shipment.

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

string | null

required

The carrier used to ship the package.

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.

data.shipments.packages.measurements

object

required

data.shipments.packages.boxes

object[]

required

A list of the boxes included in the package (AKA cartons).

Get Order Create/Update Schema Update Order

curl --request POST \
  --url https://production.trackstarhq.com/wms/orders \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '{
  "field1": "some_value",
  "field2": {
    "key": "value"
  }
}'

{
  "data": {
    "id": "order_id",
    "warehouse_customer_id": "warehouse_customer_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "reference_id": "order_reference_id",
    "order_number": "order_number",
    "status": "open",
    "channel": "channel_id",
    "trading_partner": "Target",
    "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"
    },
    "line_items": [],
    "shipments": [
      {
        "shipment_id": "shipment_id",
        "warehouse_id": "wh_id",
        "shipped_date": "2022-05-06T01:02:03Z",
        "line_items": [
          {
            "inventory_item_id": "item_id",
            "sku": "sku",
            "quantity": 1
          }
        ],
        "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": [
          {
            "tracking_number": "tracking_number",
            "tracking_url": "tracking_url",
            "carrier": "carrier",
            "scac": "scac",
            "shipping_cost": 1,
            "measurements": {
              "length": 1,
              "width": 1,
              "height": 1,
              "unit": "in",
              "weight": 1,
              "weight_unit": "lb"
            },
            "boxes": [
              {
                "box_id": "box_id",
                "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"
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

Home

How-To Guides

API Documentation

Headers

Body

Response