Skip to main content
POST
Create Return

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>"

Idempotency-Key
string

Optional key that makes this request safe to retry. Send the same key on a retry and Trackstar returns the first attempt's response instead of writing again; if the first attempt failed, the retry runs the write again. Reusing a key with a different request is rejected. Keys expire after 24 hours.

Required string length: 1 - 255
Example:

"9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00"

Body

application/json
warehouse_id
enum<string>
required

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

Available options:
N/A - Connect an account to see options
Example:

"warehouse"

order_id
enum<string>
required

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

Available options:
N/A - Connect an account to see options
Example:

"order_id"

line_items
WmsReturnWriteLineItemsandbox · object[]
required

A list of inventory items included in the return.

Example:
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:

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
CreateReturnResponseDataSchema · object