v1

latestOpenAPI 3.1.02026-07-22802,2441.7 MB

wms

Orders

Cancel Order

Cancel an order for the WMS connection with the associated order id.

put/wms/orders/{order_id}/cancel

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

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": "cancelled",
    "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",
    "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": [],
    "external_system_url": "https://example.com/order/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ],
    "additional_fields": {
      "key": "value"
    }
  },
  "id": "id"
}