- Documentation
- Request an API Key
- Login to Dashboard
Authentication
Sandbox
Inventory
Products
Orders
Inbound Shipments
Shipping Methods
Returns
Billing
Warehouses
Warehouse Customers
API Documentation
Update Return
Get the request body shape by calling the meta endpoint.
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Placeholder - variable based on integration. Read about the meta endpoint for more information.
Placeholder - variable based on integration. Read about the meta endpoint for more information.
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 '{
"field1": "some_value",
"field2": {
"key": "value"
}
}'{
"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",
"line_items": [
{
"inventory_item_id": "item_id",
"quantity": 1,
"restocked_quantity": 1,
"warehouse_id": "warehouse",
"returned_date": "2023-02-03T02:04:06Z"
}
],
"shipments": [
{
"shipped_date": "2023-02-03T02:04:06Z",
"tracking_number": "tracking_number",
"carrier": "carrier",
"shipping_cost": 1.23,
"measurements": {
"length": 1,
"width": 1,
"height": 1,
"unit": "in",
"weight": 1,
"weight_unit": "lb"
}
}
]
}
}Headers
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Path Parameters
Body
Placeholder - variable based on integration. Read about the meta endpoint for more information.
Placeholder - variable based on integration. Read about the meta endpoint for more information.
Response
The unique ID of the return.
The ID of the merchant/tenant/customer that owns the return. Can be passed into the Warehouse Customer endpoint for more details.
The date the return was created.
The date the return was last updated.
The status of the return. See the return information for more details.
open, in-transit, receiving, received, cancelled, other The raw status (if available) returned directly from the WMS.
The ID of the order that the return is associated with.
A list of inventory items included in the return.
Can be passed into the Inventory endpoint for more details.
The number of returned inventory items that have been restocked.
The ID of the warehouse receiving the return. Can be passed into the Warehouse endpoint for more details.
If the item has been returned, the date that it got back to the warehouse.
List of the shipments associated with the return.
The tracking number of the shipment.
The date the shipment was sent.
The carrier of the shipment.
The cost of the shipment.
The unit of measurement for the size of the shipment.
cm, in The unit of measurement for the weight of the shipment.
kg, lb 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 '{
"field1": "some_value",
"field2": {
"key": "value"
}
}'{
"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",
"line_items": [
{
"inventory_item_id": "item_id",
"quantity": 1,
"restocked_quantity": 1,
"warehouse_id": "warehouse",
"returned_date": "2023-02-03T02:04:06Z"
}
],
"shipments": [
{
"shipped_date": "2023-02-03T02:04:06Z",
"tracking_number": "tracking_number",
"carrier": "carrier",
"shipping_cost": 1.23,
"measurements": {
"length": 1,
"width": 1,
"height": 1,
"unit": "in",
"weight": 1,
"weight_unit": "lb"
}
}
]
}
}