API Documentation
- Management
- Sandbox
- Inventory
- Products
- Orders
- Inbound Shipments
- Shipping Methods
- Returns
- Billing
- Warehouses
- Warehouse Customers
Update Return Trackstar Tags
Update the trackstar tags for the specified return.
Headers
Your organization-level Trackstar API key.
Your user's access token for a specific integration (ShipHero, Extensiv, etc).
Path Parameters
Body
A list of custom tags associated with the returns. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]
Response
The date the return was created.
URL link to the return in the external system (WMS/Freight etc).
The unique ID of the return.
A list of inventory items included in the return.
How many units are expected to arrive.
Can be passed into the Inventory endpoint for more details.
This field is deprecated.
How many units actually arrived.
The number of returned inventory items that have been restocked.
The reason for the return.
This field is deprecated.
This field is deprecated.
A list of notes associated with the return.
The ID of the order that the return is associated with. Can be passed into the Order endpoint for more details.
The raw status (if available) returned directly from the WMS.
List of the shipments associated with the return.
The date the shipment arrived.
The carrier of the shipment.
List of inventory items items in the shipment.
Can be passed into the Inventory endpoint for more details.
How many units were shipped.
Details about received items in the shipment.
The condition of the item received.
The disposition of the item received, eg restocked or discarded.
How many units were received in this condition and disposition.
The unit of measurement for the size of the shipment.
cm
, in
The unit of measurement for the weight of the shipment.
kg
, oz
, lb
The date the shipment was sent.
The cost of the shipment.
The tracking number of the shipment.
The status of the return. See the return information for more details.
open
, in-transit
, receiving
, received
, cancelled
, other
A list of custom tags associated with the return. A tag can be either a string or a dictionary with one key-value pair. e.g. ['tag1', 'tag2', {'key1': 'value1'}]
The date the return was last updated.
The ID of the merchant/tenant/customer that owns the return. Can be passed into the Warehouse Customer endpoint for more details.
The ID of the object that has been created or modified
Unused fields