Skip to main content
POST
/
wms
/
returns
Create Return
curl --request POST \
  --url https://production.trackstarhq.com/wms/returns \
  --header 'Content-Type: application/json' \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>' \
  --data '{
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ],
  "warehouse_id": "warehouse",
  "order_id": "order_id",
  "line_items": [
    {
      "sku": "sku",
      "quantity": 1
    }
  ]
}'
{
  "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",
    "notes": [
      "This is a note"
    ],
    "line_items": [
      {
        "inventory_item_id": "item_id",
        "sku": "sku",
        "expected_quantity": 1,
        "received_quantity": 1,
        "restocked_quantity": 1,
        "return_reason": "Too Small",
        "quantity": 0,
        "warehouse_id": "deprecated",
        "returned_date": "deprecated"
      }
    ],
    "shipments": [],
    "external_system_url": "https://example.com/return/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ],
    "additional_fields": {
      "key": "value"
    }
  },
  "id": "id",
  "unused_fields": [
    ""
  ]
}

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
  • Base_Schema
  • Bleckmann
  • BlueBox (IDrive Fulfillment)
  • Cirro
  • DCL
  • Deposco
  • Extensiv (3PL Central)
  • Flexport (Deliverr)
  • I-Fulfilment
  • Infoplus
  • Cart.com (Jazz Central)
  • Linnworks
  • Logiwa
  • Logiwa IO
  • MasonHub
  • Nimble
  • Ongoing WMS
  • Quiet Platforms
  • WMS Sandbox
  • ShipBob
  • ShipHero
  • ShipMonk
  • Shippingbo
  • ShipStream
  • Shipwire
  • Smart Warehousing
  • Whiplash (Ryder)
​
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:
["tag1", "tag2", { "tag3": "value3" }]
​
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
WmsReturnWriteLineItem · object[]

A list of inventory items included in the return.

Example:
[{ "sku": "sku", "quantity": 1 }]

Response

Successful response

​
data
object
​
id
string

The ID of the object that has been created or modified

Example:

"id"

​
unused_fields
string[]

Unused fields