Skip to main content
PUT
/
wms
/
returns
/
{return_id}
Update Return
curl --request PUT \
  --url https://production.trackstarhq.com/wms/returns/{return_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_id": "warehouse",
  "order_id": "order_id",
  "line_items": [
    {
      "sku": "sku",
      "expected_quantity": 1
    }
  ]
}
'
{
  "id": "id",
  "unused_fields": [
    "<string>"
  ],
  "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": "open",
    "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": [
      {
        "tracking_number": "tracking_number",
        "shipped_date": "2023-02-03T02:04:06Z",
        "arrived_date": "2023-02-03T02:04:06Z",
        "warehouse_id": "warehouse_id",
        "carrier_id": "carrier_id",
        "carrier_name": "carrier_name",
        "scac": "FDXG",
        "shipping_cost": 1.23,
        "measurements": {
          "length": 1,
          "width": 1,
          "height": 1,
          "unit": "in",
          "weight": 1,
          "weight_unit": "lb"
        },
        "line_items": [
          {
            "inventory_item_id": "item_id",
            "sku": "sku",
            "quantity": 4,
            "receiving_details": [
              {
                "quantity": 1,
                "condition": "good",
                "disposition": "restocked"
              },
              {
                "quantity": 1,
                "condition": "damaged",
                "disposition": "scrapped"
              }
            ]
          }
        ]
      }
    ],
    "external_system_url": "https://example.com/return/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ],
    "additional_fields": {
      "key": "value"
    },
    "trackstar_created_date": "2023-11-07T05:31:56Z",
    "trackstar_updated_date": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.trackstarhq.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
return_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_id
string

The ID of the warehouse receiving the return. Can be passed into the Warehouse endpoint for more details.

Example:

"warehouse"

​
order_id
string

The ID of the order that the return is associated with. Can be passed into the Order endpoint for more details.

Example:

"order_id"

​
line_items
UpdateWmsReturnLineItemSchema · object[]

A list of inventory items included in the return.

Example:
[{ "sku": "sku", "expected_quantity": 1 }]

Response

Successful response

​
id
string
required

The ID of the object that has been created or modified

Example:

"id"

​
unused_fields
string[]
required

Unused fields

​
data
WmsReturnApiItemSchema · object