Update or move inventory

Update inventory quantities at a specific location or move inventory between warehouse locations

Request Body

application/jsonRequired

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"

warehouseLocationIdRequiredstring

The warehouse location ID where the inventory is located

Format: "uuid"

changeQuantityRequiredinteger

The quantity to add (positive) or remove (negative). For moves, must be positive.

moveToWarehouseLocationIdstring

If provided, will move inventory to this warehouse location instead of updating quantity

Format: "uuid"

reasonstring

Reason for the inventory change or move

warehouseIdRequiredstring

The warehouse ID to scope operations

Format: "uuid"

curl -X POST "https://www.shipsidekick.com/api/v1/inventory" \
  -H "Content-Type: application/json" \
  -d '{
    "productVariantIdentifier": "WHITETEE",
    "identifierType": "sku",
    "warehouseLocationId": "cmea9fzvv00b4mkmp9ktawc7e",
    "changeQuantity": 50,
    "reason": "Received new stock",
    "warehouseId": "cmea9fzvv00b4mkmp9ktawc7e"
  }'

Successful response

{
  "object": "inventoryUpdate",
  "success": true,
  "message": "Successfully added 50 units to A-01-01",
  "data": {
    "id": "cmea9mpv7002bmktvm9plplez",
    "organizationId": "cmea9fzxt00ccmkmpkwzwsata",
    "warehouseLocationId": "cmea9fzvv00b4mkmp9ktawc7e",
    "productVariantId": "cmea9mki30015mktvhpdebfta",
    "quantity": 150,
    "unitsOfMeasureId": null,
    "uomQuantity": null,
    "expirationDate": null,
    "lotNumber": null,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T14:45:00Z",
    "archivedAt": null
  }
}

Update or move inventory

Request Body

Response

TypeScript