erp
Inventory

Get ERP Inventory Item

Changed on

Returns a single Inventory Item for the ERP connection with the associated inventory id.

get/erp/inventory/{inventory_id}

Request

  • Base URL
    https://production.trackstarhq.com
  • URL
    https://production.trackstarhq.com/erp/inventory/{inventory_id}
  • Auth
    none required

Path parameters

inventory_idstring 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).

Response

Successful response

Example response

{
  "data": {
    "id": "inv_id",
    "created_date": "2022-01-01T00:00:00Z",
    "updated_date": "2022-01-02T05:05:05Z",
    "name": "Apple - Fuji",
    "sku": "10000",
    "upc": "012345678905",
    "active": true,
    "description": "Fuji apple, loose",
    "unit_cost": 1,
    "costing_method": "Standard",
    "stock_unit": "EA",
    "onhand": 42.5,
    "committed": 2.5,
    "available": 40,
    "inventory_by_location_id": {
      "location_id_1": {
        "onhand": 42.5,
        "committed": 2.5,
        "available": 40
      },
      "location_id_2": {
        "onhand": 0,
        "committed": 0,
        "available": 0
      }
    },
    "vendors": [
      {
        "vendor_id": "vendor_1",
        "vendor_name": "Acme Produce Co."
      }
    ],
    "lots": [
      {
        "lot_id": "9821",
        "lot_name": "LOT-20260418-A",
        "onhand": 240,
        "expiration_date": "2026-05-09T00:00:00Z",
        "location_id": "114"
      }
    ],
    "bins": [
      {
        "bin_id": "157",
        "bin_name": "C-03-L3-P2",
        "onhand": 240,
        "location_id": "114",
        "lot_id": "9821"
      }
    ],
    "custom_fields": {
      "custom_field_example": {
        "value": "example_value",
        "type": "string",
        "title": "Example Field"
      }
    },
    "measurements": {
      "length": 1.5,
      "width": 1.5,
      "height": 1.5,
      "unit": "in",
      "weight": 2.5,
      "weight_unit": "lb"
    },
    "external_system_url": "https://example.com/inventoryitem/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"
  }
}

Changes