Skip to main content
POST
/
wms
/
orders
Create 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 '
{
  "warehouse_customer_id": "warehouse_customer_id",
  "reference_id": "order_reference_id",
  "order_number": "order_number",
  "channel_object": {
    "channel_id": "channel_id"
  },
  "trading_partner": "Target",
  "shipping_method_id": "fedex_ground",
  "service_level": "Standard",
  "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",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "United States"
  },
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ],
  "line_items": [
    {
      "product_id": "product_id",
      "sku": "sku",
      "quantity": 1,
      "unit_price": 10.99,
      "discount_amount": 1.5
    }
  ]
}
'
{
  "id": "id",
  "unused_fields": [
    "<string>"
  ],
  "data": {
    "id": "order_id",
    "warehouse_customer_id": "warehouse_customer_id",
    "warehouse_id": "warehouse_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",
    "raw_status": "raw_status",
    "channel": "channel_id",
    "channel_object": {
      "channel_id": "channel_id",
      "channel_name": "channel_name"
    },
    "type": "d2c",
    "trading_partner": "Target",
    "shipping_method": "<string>",
    "service_level": "Standard",
    "shipping_method_id": "fedex_ground",
    "shipping_method_name": "FedEx Ground",
    "carrier_id": "fedex",
    "carrier_name": "FedEx",
    "scac": "<string>",
    "is_third_party_freight": false,
    "third_party_freight_account_number": "123456",
    "first_party_freight_account_number": "123456",
    "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": "johndoe@example.com"
    },
    "line_items": [
      {
        "product_id": "product_id",
        "sku": "sku",
        "quantity": 1,
        "unit_price": 10.99,
        "is_picked": false,
        "discount_amount": 1.5
      }
    ],
    "tags": [
      "tag_0"
    ],
    "required_ship_date": "2021-01-01T12:00:00Z",
    "saturday_delivery": false,
    "signature_required": false,
    "international_duty_paid_by": "sender",
    "shipments": [],
    "external_system_url": "https://example.com/order/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ],
    "additional_fields": {
      "key": "value"
    },
    "trackstar_created_date": "2023-11-07T05:31:56Z",
    "trackstar_updated_date": "2023-11-07T05:31:56Z"
  }
}

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

Body

application/json
​
warehouse_customer_id
string | null
required

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"

​
reference_id
string
required

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
string
required

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

Example:

"order_number"

​
channel_object
ChannelId · object
required

The channel the order was placed on.

​
trading_partner
string
required

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

Example:

"Target"

​
shipping_method_id
string
required

The ID of the actual shipping method used to ship the order. Can be passed into the Shipping Method endpoint for more details.. If shipping_method_name is also provided, this will take precedence.

Example:

"fedex_ground"

​
service_level
string
required

The type of shipping method requested by the customer.

Example:

"Standard"

​
invoice_currency_code
string
required

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

Example:

"USD"

​
total_price
number
required

The total price a customer paid for the order.

Example:

13.49

​
total_tax
number
required

The total tax on the order.

Example:

1.5

​
total_discount
number
required

The total amount discounted from the order.

Example:

2.5

​
total_shipping
number
required

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

Example:

3.5

​
ship_to_address
CreateWmsOrderShipToAddress · object
required
​
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" }]
​
line_items
CreateWmsOrderLineItems · object[]

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

Response

Successful response

​
id
string
required

The ID of the object that has been created or modified

Example:

"id"

​
unused_fields
string[]
required

Unused fields

​
data
CreateWmsOrderResponseDataSchema · object