TRtrackstarhq
wms
Warehouses

Create Warehouse

Changed on

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

post/wms/warehouses

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/wms/warehouses
  • 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

Example request

{
  "trackstar_tags": [
    "tag1",
    "tag2",
    {
      "tag3": "value3"
    }
  ],
  "name": "Bethlehem (PA)",
  "code": "ABE-1",
  "address": {
    "address1": "123 Main St",
    "address2": "Apt 2",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "United States"
  }
}

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": "warehouse_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "name": "Bethlehem (PA)",
    "code": "ABE-1",
    "address": {
      "address1": "123 Main St",
      "address2": "Apt 2",
      "address3": "Floor 3",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "United States"
    },
    "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