Cancel Order - Trackstar

PUT

wms

orders

{order_id}

cancel

curl --request PUT \
  --url https://production.trackstarhq.com/wms/orders/{order_id}/cancel \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'

{
  "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": "shipping_method_id",
    "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"
    },
    "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"
      }
    ]
  },
  "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

Response

200

application/json

Successful response

data

object

data.id

string

The unique ID of the order.

Example:

"order_id"

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.

Example:

"warehouse_customer_id"

data.warehouse_id

string | null

If set at the order level, the expected warehouse the order will be shipped from. At the shipment level, the warehouse the shipment was shipped from. Can be passed into the Warehouse endpoint for more details.

Example:

"warehouse_id"

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

data.order_number

string

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

Example:

"order_number"

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

data.raw_status

string | null

The raw status (if available) returned directly from the WMS.

Example:

"raw_status"

data.channel

string | null

Deprecated in favor of channel_object.

Example:

"channel_id"

data.channel_object

object | null

data.type

enum<string> | null

The type of order, such as d2c or b2b.

Available options:

d2c,

b2b,

dropship

Example:

"d2c"

data.trading_partner

string | null

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

Example:

"Target"

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.

Example:

"shipping_method_id"

data.is_third_party_freight

boolean | null

True if the order was shipped using a third party freight account.

Example:

false

data.third_party_freight_account_number

string | null

The third party freight account number used to ship the order.

Example:

"123456"

data.first_party_freight_account_number

string | null

The first party freight account number used to ship the order.

Example:

"123456"

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

object[]

List of the products included in the order.

Example:

[
  {
    "product_id": "product_id",
    "sku": "sku",
    "quantity": 1,
    "unit_price": 10.99,
    "is_picked": false,
    "discount_amount": 1.5
  }
]

data.tags

string[]

A list of tags associated with the order. Tags that are represented as key-value pairs in the WMS will be represented as a single string formatted as key:value.

A tag associated with the order.

Example:

["tag_0"]

data.required_ship_date

string | null

The date the order must be shipped by.

Example:

"2021-01-01T12:00:00Z"

data.saturday_delivery

boolean | null

True if the order requires Saturday delivery.

Example:

false

data.signature_required

boolean | null

True if the order requires a signature upon delivery.

Example:

false

data.international_duty_paid_by

enum<string> | null

The party responsible for paying international duties.

Available options:

sender,

recipient,

third_party

Example:

"sender"

data.shipments

object[]

List of the shipments sent out to the customer.

data.shipments.shipment_id

string

required

The ID of the shipment.

Example:

""

data.shipments.warehouse_id

string

required

The warehouse this order was shipped from. Can be passed into the Warehouse endpoint for more details.

Example:

""

data.shipments.raw_status

string | null

required

The raw status (if available) of the shipment returned directly from the WMS.

Example:

"raw_status"

data.shipments.status

enum<string>

required

The status of the shipment.

Available options:

open,

shipped,

cancelled,

other

Example:

"shipped"

data.shipments.shipped_date

string

required

The date the shipment was sent.

Example:

"2022-05-06T01:02:03Z"

data.shipments.shipping_method

string | null

required

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

Example:

"shipping_method_id"

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

string

required

The ID of the package.

Example:

""

data.shipments.packages.package_name

string | null

required

The name of the package. (e.g. 12x9x4)

Example:

""

data.shipments.packages.tracking_number

string | null

required

The tracking number for the package.

Example:

""

data.shipments.packages.tracking_url

string | null

required

The URL for the tracking number.

Example:

""

data.shipments.packages.shipping_method

string | null

required

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

Example:

"shipping_method_id"

data.shipments.packages.carrier

string | null

required

The carrier used to ship the package.

Example:

""

data.shipments.packages.scac

string | null

required

The Standard Carrier Alpha Code for the carrier used to ship the package.

Example:

""

data.shipments.packages.shipping_cost

number | null

required

The cost incurred by the warehouse to ship the package.

Example:

2.5

data.shipments.packages.measurements

object

required

data.shipments.packages.line_items

object[]

required

A list of the inventory items included in the package.

Example:

[]

data.external_system_url

string | null

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

Example:

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

data.trackstar_tags

any[] | null

A list of custom tags associated with the order. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]

Example:

["tag1", "tag2", { "tag3": "value3" }]

string

The ID of the object that has been created or modified

Example:

"id"

unused_fields

string[]

Unused fields

Update Order Ship Order

curl --request PUT \
  --url https://production.trackstarhq.com/wms/orders/{order_id}/cancel \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'

{
  "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": "shipping_method_id",
    "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"
    },
    "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"
      }
    ]
  },
  "id": "id",
  "unused_fields": [
    ""
  ]
}

API Documentation

Headers

Path Parameters

Response