PUT
/
wms
/
orders
/
{order_id}
Update Order
curl --request PUT \
  --url https://production.trackstarhq.com/wms/orders/{order_id} \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '{
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ],
  "warehouse_customer_id": "warehouse_customer_id",
  "reference_id": "order_reference_id",
  "order_number": "order_number",
  "channel": "channel_id",
  "channel_object": {
    "channel_id": "channel_id"
  },
  "trading_partner": "Target",
  "shipping_method_id": "fedex_ground",
  "shipping_method": "shipping_method_id",
  "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": "",
    "company": "",
    "address1": "",
    "address2": "",
    "city": "",
    "state": "",
    "postal_code": "",
    "country": ""
  },
  "line_items": [
    {
      "product_id": "product_id",
      "sku": "sku",
      "quantity": 1,
      "unit_price": 10.99,
      "discount_amount": 1.5
    }
  ],
  "status": "open"
}'
{
  "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": {},
    "type": "d2c",
    "trading_partner": "Target",
    "shipping_method": "",
    "service_level": "Standard",
    "shipping_method_id": "fedex_ground",
    "shipping_method_name": "FedEx Ground",
    "carrier_id": "fedex",
    "carrier_name": "FedEx",
    "scac": "",
    "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": [
      {
        "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
              }
            ]
          }
        ]
      }
    ],
    "external_system_url": "https://example.com/order/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ],
    "additional_fields": {
      "key": "value"
    }
  },
  "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
​
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" }]
​
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"

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

​
order_number
string

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

Example:

"order_number"

​
channel
string

Deprecated in favor of channel_object.

Example:

"channel_id"

​
channel_object
object

The channel the order was placed on.

​
trading_partner
string

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

Example:

"Target"

​
shipping_method_id
string

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"

​
shipping_method
string

The method by which the warehouse will ship the order to the customer. Can be passed into the Shipping Method endpoint for more details.. Deprecated in favor of service_level and shipping_method_id.

Example:

"shipping_method_id"

​
service_level
string

The type of shipping method requested by the customer.

Example:

"Standard"

​
invoice_currency_code
string

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

Example:

"USD"

​
total_price
number

The total price a customer paid for the order.

Example:

13.49

​
total_tax
number

The total tax on the order.

Example:

1.5

​
total_discount
number

The total amount discounted from the order.

Example:

2.5

​
total_shipping
number

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

Example:

3.5

​
ship_to_address
object
​
line_items
UpdateOrderLineItems · 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
  }
]
​
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"

Response

Successful response

​
data
object
​
id
string

The ID of the object that has been created or modified

Example:

"id"

​
unused_fields
string[]

Unused fields