Update Return - Trackstar

Headers

x-trackstar-api-key

string

required

Your organization-level Trackstar API key.

x-trackstar-access-token

string

required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Path Parameters

return_id

string

required

Body

application/json

warehouse_id

string

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

order_id

string

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

line_items

object[]

A list of inventory items included in the return.

trackstar_tags

any[] | null

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

200 - application/json

data

object

data.id

string

The unique ID of the return.

data.warehouse_customer_id

string | null

The ID of the merchant/tenant/customer that owns the return. Can be passed into the Warehouse Customer endpoint for more details.

data.created_date

string

The date the return was created.

data.updated_date

string

The date the return was last updated.

data.status

enum<string>

The status of the return. See the return information for more details.

Available options:

open,

in-transit,

receiving,

received,

cancelled,

other

data.raw_status

string | null

The raw status (if available) returned directly from the WMS.

data.order_id

string | null

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

data.notes

string[]

A list of notes associated with the return.

data.line_items

object[]

A list of inventory items included in the return.

data.shipments

object[]

List of the shipments associated with the return.

data.shipments.tracking_number

string | null

required

The tracking number of the shipment.

data.shipments.shipped_date

string | null

required

The date the shipment was sent.

data.shipments.arrived_date

string | null

required

The date the shipment arrived.

data.shipments.warehouse_id

string | null

required

The ID of the warehouse the shipment was sent to. Can be passed into the Warehouse endpoint for more details.

data.shipments.carrier

string | null

required

The carrier of the shipment.

data.shipments.shipping_cost

number | null

required

The cost of the shipment.

data.shipments.measurements

object

required

data.shipments.line_items

object[]

required

List of inventory items items in the shipment.

data.external_system_url

string | null

URL link to the return in the external system (WMS/Freight etc).

data.trackstar_tags

any[] | null

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'}]

unused_fields

string[]

Unused fields

API Documentation

Headers

Path Parameters

Body

Response