Create Return - Trackstar

POST

wms

returns

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 '{
  "warehouse_id": "warehouse",
  "order_id": "order_id",
  "line_items": [
    {
      "sku": "sku",
      "quantity": 1
    }
  ],
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ]
}'

{
  "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": 1,
        "warehouse_id": "warehouse_id",
        "returned_date": ""
      }
    ],
    "shipments": [],
    "external_system_url": "https://example.com/return/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ]
  },
  "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

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

object[]

A list of inventory items included in the return.

Example:

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

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

Example:

["tag1", "tag2", { "tag3": "value3" }]

Response

200

application/json

Successful response

data

object

data.id

string

The unique ID of the return.

Example:

"return_id"

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.

Example:

"warehouse_customer_id"

data.created_date

string

The date the return was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string

The date the return was last updated.

Example:

"2022-01-02T05:05:05Z"

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

Example:

"open"

data.raw_status

string | null

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

Example:

"raw_status"

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.

Example:

"order_id"

data.notes

string[]

A list of notes associated with the return.

This is a note

Example:

["This is a note"]

data.line_items

object[]

A list of inventory items included in the return.

Example:

[
  {
    "inventory_item_id": "item_id",
    "sku": "sku",
    "expected_quantity": 1,
    "received_quantity": 1,
    "restocked_quantity": 1,
    "return_reason": "Too Small",
    "quantity": 1,
    "warehouse_id": "warehouse_id",
    "returned_date": ""
  }
]

data.shipments

object[]

List of the shipments associated with the return.

data.shipments.tracking_number

string | null

required

The tracking number of the shipment.

Example:

""

data.shipments.shipped_date

string | null

required

The date the shipment was sent.

Example:

""

data.shipments.arrived_date

string | null

required

The date the shipment arrived.

Example:

""

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.

Example:

"warehouse_id"

data.shipments.carrier

string | null

required

The carrier of the shipment.

Example:

""

data.shipments.shipping_cost

number | null

required

The cost of the shipment.

Example:

0

data.shipments.measurements

object

required

data.shipments.line_items

object[]

required

List of inventory items items in the shipment.

data.shipments.line_items.inventory_item_id

string

required

Can be passed into the Inventory endpoint for more details.

Example:

"item_id"

data.shipments.line_items.sku

string | null

required

Example:

"sku"

data.shipments.line_items.quantity

integer

required

How many units were shipped.

Example:

1

data.shipments.line_items.receiving_details

object[]

required

Details about received items in the shipment.

Example:

[
  {
    "quantity": 1,
    "condition": "good",
    "disposition": "restocked"
  }
]

Example:

[]

data.external_system_url

string | null

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

Example:

"https://example.com/return/123"

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

Example:

["tag1", "tag2", { "tag3": "value3" }]

string

The ID of the object that has been created or modified

Example:

"id"

unused_fields

string[]

Unused fields

Get Return Update 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 '{
  "warehouse_id": "warehouse",
  "order_id": "order_id",
  "line_items": [
    {
      "sku": "sku",
      "quantity": 1
    }
  ],
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ]
}'

{
  "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": 1,
        "warehouse_id": "warehouse_id",
        "returned_date": ""
      }
    ],
    "shipments": [],
    "external_system_url": "https://example.com/return/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ]
  },
  "id": "id",
  "unused_fields": [
    ""
  ]
}

API Documentation

Headers

Body

Response