TRtrackstarhq
wms
Returns

Create Return

Changed on

Get the required, optional, and integration specific fields by calling the integrations endpoint.

post/wms/returns

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/wms/returns
  • Auth
    none required

Headers

x-trackstar-api-keystring required
Example:<x-trackstar-api-key>

Your organization-level Trackstar API key.

x-trackstar-access-tokenstring required
Example:<x-trackstar-access-token>

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

Idempotency-Keystring
Example:9f1c2b1e-6d4a-4c1c-9a8e-2b7e3c5d1f00

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.

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ],
  "warehouse_id": "warehouse",
  "order_id": "order_id",
  "line_items": [
    {
      "sku": "XS-RED-SHIRT",
      "expected_quantity": 1,
      "return_reason": "damaged"
    }
  ]
}

Response

Successful response

idstring required

The ID of the object that has been created or modified

unused_fieldsstring[] required

Unused fields

Example response

{
  "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"
      }
    ],
    "shipments": [],
    "external_system_url": "https://example.com/return/123",
    "trackstar_tags": [
      "tag1",
      "tag2",
      {
        "tag3": "value3"
      }
    ],
    "additional_fields": {
      "key": "value"
    },
    "trackstar_created_date": "2023-03-15T13:45:30Z",
    "trackstar_updated_date": "2023-03-15T13:45:30Z"
  },
  "id": "id",
  "unused_fields": [
    "unused_fields"
  ]
}

Changes

  • f9f948f2a7b3Revision changes
    • breaking

      removed from the request body oneOf list

    • breaking

      added subschema #1 to the // request property allOf list

    • breaking

      removed the enum value exchange of the request property ///

    • breaking

      removed the enum value other of the request property ///

    • breaking

      removed the enum value refund of the request property ///

    • breaking

      removed the enum value replacement of the request property ///

    • breaking

      added the pattern ^[0-9]+$ to the request property /

    • breaking

      added the pattern ^[0-9]+$ to the request property /

    • breaking

      added the pattern ^[0-9]+$ to the request property /

    • breaking

      added the pattern ^[0-9]+$ to the request property /

    • breaking

      added the pattern ^[0-9]+$ to the request property /

    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the new optional request property /

    • info

      added the new optional request property ///

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added to the request body oneOf list

    • info

      added id name discriminator mapping keys to the / request property