Update Order

Changed on Nov 3, 2026

Get the required, optional, and integration specific fields by calling the integrations endpoint.

put/wms/orders/{order_id}

Request

Base URL
https://production.trackstarhq.com
URL
https://production.trackstarhq.com/wms/orders/{order_id}
Auth
none required

Path parameters

order_idstring required

Headers

x-trackstar-api-keystring required

Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required

Example:<x-trackstar-access-token>

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

Idempotency-Keystring

Example:9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00

Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.

Request body

Example request

{
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ],
  "warehouse_id": "warehouse_id",
  "reference_id": "order_reference_id",
  "order_number": "so_56017",
  "channel_object": {
    "channel_id": "channel_id"
  },
  "shipping_method_id": "fedex_ground",
  "service_level": "Standard",
  "invoice_currency_code": "USD",
  "total_price": 13.49,
  "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"
  },
  "line_items": [
    {
      "sku": "sku",
      "quantity": 1
    }
  ]
}

Response

Successful response

idstring required

The ID of the object that has been created or modified

unused_fieldsstring[] required

Unused fields

Example response

{
  "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_object": {
      "channel_id": "channel_id",
      "channel_name": "channel_name"
    },
    "type": "d2c",
    "trading_partner": "Target",
    "service_level": "Standard",
    "shipping_method_id": "fedex_ground",
    "shipping_method_name": "FedEx Ground",
    "carrier_id": "fedex",
    "carrier_name": "FedEx",
    "scac": "scac",
    "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,
        "discount_amount": 1.5
      }
    ],
    "tags": [
      "tag_0"
    ],
    "required_ship_date": "2021-01-01T12:00:00Z",
    "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",
        "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_id": "shipping_method_id",
            "shipping_method_name": "shipping_method_name",
            "carrier_id": "carrier_id",
            "carrier_name": "carrier_name",
            "scac": "scac",
            "bill_of_lading": "bill_of_lading",
            "sscc": "sscc",
            "pro_number": "pro_number",
            "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"
    },
    "trackstar_created_date": "2023-03-15T13:45:30Z",
    "trackstar_updated_date": "2023-03-15T13:45:30Z"
  },
  "id": "id",
  "unused_fields": [
    "unused_fields"
  ]
}

Changes

Nov 3, 2026f9f948f2a7b3 Revision changes
- breaking
  removed from the request body oneOf list
- breaking
  added subschema #1 to the // request property allOf list
- breaking
  the // request property's minLength was increased from 0 to 2
- breaking
  added the pattern ^[0-9]+$ to the request property /
- breaking
  added the pattern ^[0-9]+$ to the request property /
- breaking
  added the pattern ^[0-9]+$ to the request property /
- breaking
  added the pattern ^[0-9]+$ to the request property /
- breaking
  added the pattern ^[0-9]+$ to the request property /
- breaking
  added the pattern ^[0-9]+$ to the request property ///
- warning
  the // request property's maxLength was set to 2
- warning
  the // request property's maxLength was set to 6
- warning
  the // request property's maxLength was set to 32
- warning
  the // request property's maxLength was set to 32
- info
  added the new optional header request parameter Idempotency-Key
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property /
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property ///
- info
  added the new optional request property /
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property /
- info
  added to the request body oneOf list
- info
  the request property // became optional
- info
  the request property / became optional
- info
  the request property default value changed from rate_shop to masonhub
- info
  added id name discriminator mapping keys to the / request property
- info
  added id name discriminator mapping keys to the / request property
- info
  added id name discriminator mapping keys to the / request property
- info
  added id name discriminator mapping keys to the / request property
- info
  added id name discriminator mapping keys to the / request property
- info
  added the new 2day enum value to the request property /
- info
  added the new 3day enum value to the request property /
- info
  added the new groundPlus enum value to the request property /
- info
  added the new groundSelect enum value to the request property /
- info
  added the new masonhub enum value to the request property /
- info
  added the new priorityOvernight enum value to the request property /
- info
  added the new standardOvernight enum value to the request property /
- info
  added the required property ///// to the response with the status
- info
  added the required property ///// to the response with the status
- info
  added the required property ///// to the response with the status

Operation history