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

Body

application/json
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:
warehouse_id
string

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

Example:

"warehouse"

order_id
string

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

Example:

"order_id"

line_items
CreateWmsReturnLineItemSchema · object[]

A list of inventory items included in the return.

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