Skip to content

insertManualInventoryAdjustment

WRITE

Insert manual inventory adjustment.

POST /api/v1/inventory/insertManualInventoryAdjustment
curl -X POST '<your-host>/api/v1/inventory/insertManualInventoryAdjustment' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "itemId": "string",
    "adjustmentType": "Positive Adjmt.",
    "quantity": 0,
    "idempotencyKey": "string"
  }'
Response
{
  "id": "…"
}

Parameters

ParameterType
"Positive Adjmt.""Negative Adjmt.""Set Quantity""Scrap""Unscrap"

Names this one adjustment: send the same key again to retry it, and it posts once; a new adjustment takes a new key

min length 1
min length 1

Input schema

schema
{
  "type": "object",
  "properties": {
    "itemId": {
      "type": "string",
      "minLength": 1
    },
    "locationId": {
      "type": "string"
    },
    "storageUnitId": {
      "type": "string"
    },
    "originalStorageUnitId": {
      "type": "string"
    },
    "adjustmentType": {
      "type": "string",
      "enum": [
        "Positive Adjmt.",
        "Negative Adjmt.",
        "Set Quantity",
        "Scrap",
        "Unscrap"
      ]
    },
    "quantity": {
      "type": "number"
    },
    "trackedEntityId": {
      "type": "string"
    },
    "readableId": {
      "type": "string"
    },
    "expirationDate": {
      "type": "string"
    },
    "comment": {
      "type": "string"
    },
    "scrapReasonId": {
      "type": "string"
    },
    "unscrapOfItemLedgerId": {
      "type": "string"
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 1,
      "description": "Names this one adjustment: send the same key again to retry it, and it posts once; a new adjustment takes a new key"
    }
  },
  "required": [
    "itemId",
    "adjustmentType",
    "quantity",
    "idempotencyKey"
  ]
}