v1

latestOpenAPI 3.1.02026-07-22802,2441.7 MB

wms

Returns

Cancel Return

Cancel a return for the WMS connection with the associated return id.

put/wms/returns/{return_id}/cancel

Path parameters

return_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": "return_id",
    "warehouse_customer_id": "warehouse_customer_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "status": "cancelled",
    "raw_status": "raw_status",
    "order_id": "order_id",
    "notes": [
      "This is a note"
    ],
    "line_items": [
      {
        "inventory_item_id": "item_id",
        "sku": "sku",
        "expected_quantity": 1,
        "received_quantity": 1,
        "restocked_quantity": 1,
        "return_reason": "Too Small"
      }
    ],
    "shipments": [],
    "external_system_url": "https://example.com/return/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ],
    "additional_fields": {
      "key": "value"
    }
  },
  "id": "id"
}