WMS API Reference
- Inventory
- Products
- Orders
- Inbound Shipments
- Shipping Methods
- Returns
- Billing
- Warehouses
- Warehouse Customers
Returns
Update Return Trackstar Tags
Update the trackstar tags for the specified return.
PUT
/
wms
/
returns
/
{return_id}
/
trackstar-tags
curl --request PUT \
--url https://production.trackstarhq.com/wms/returns/{return_id}/trackstar-tags \
--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"
}
]
}'
{
"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",
"quantity": 0,
"warehouse_id": "deprecated",
"returned_date": "deprecated"
}
],
"shipments": [
{
"tracking_number": "tracking_number",
"shipped_date": "2023-02-03T02:04:06Z",
"arrived_date": "2023-02-03T02:04:06Z",
"warehouse_id": "warehouse_id",
"carrier": "carrier",
"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"
}
},
"id": "id",
"unused_fields": [
""
]
}
Headers
Your organization-level Trackstar API key.
Example:
"<x-trackstar-api-key>"
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Example:
"<x-trackstar-access-token>"
Path Parameters
Body
application/json
Response
200
application/json
Successful response
The response is of type object
.
curl --request PUT \
--url https://production.trackstarhq.com/wms/returns/{return_id}/trackstar-tags \
--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"
}
]
}'
{
"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",
"quantity": 0,
"warehouse_id": "deprecated",
"returned_date": "deprecated"
}
],
"shipments": [
{
"tracking_number": "tracking_number",
"shipped_date": "2023-02-03T02:04:06Z",
"arrived_date": "2023-02-03T02:04:06Z",
"warehouse_id": "warehouse_id",
"carrier": "carrier",
"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"
}
},
"id": "id",
"unused_fields": [
""
]
}