List inventory locations

Query Parameters

productVariantIdentifierRequiredstring

The product variant identifier (can be sku, barcode, id, etc.)

identifierTypestring

The type of identifier. If not provided, will try to auto-detect.

Value in: "id" | "sku" | "skuAliases" | "barcode"

warehouseIdRequiredstring

The warehouse ID to filter inventory locations

Format: "uuid"

curl -X GET "https://www.shipsidekick.com/api/v1/inventory/locations?productVariantIdentifier=string&identifierType=id&warehouseId=497f6eca-6276-4993-bfeb-53cbbbba6f08"

Successful response

{
  "object": "list",
  "data": [
    {
      "id": "cmea9mpv7002bmktvm9plplez",
      "organizationId": "cmea9fzxt00ccmkmpkwzwsata",
      "warehouseLocationId": "cmea9fzvv00b4mkmp9ktawc7e",
      "productVariantId": "cmea9mki30015mktvhpdebfta",
      "quantity": 100,
      "unitsOfMeasureId": null,
      "uomQuantity": null,
      "expirationDate": null,
      "lotNumber": null,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z",
      "archivedAt": null,
      "organization": null,
      "productVariant": {
        "id": "cmea9mki30015mktvhpdebfta",
        "title": "White T-Shirt",
        "sku": "WHITETEE"
      },
      "warehouseLocation": {
        "id": "cmea9fzvv00b4mkmp9ktawc7e",
        "name": "A-01-01",
        "type": "bin",
        "pickable": true
      },
      "unitsOfMeasure": null
    }
  ],
  "totalCount": 1
}

List inventory locations

Query Parameters

Response

TypeScript