Stock

Adjust item stock.

Adjusts an item's stock quantity using the specified quantity, adjustment action, and stock movement type.

put/stock/adjust

Request

  • Base URL
    https://api.digitax.tech/ke/v2
  • Auth
    API key in header X-API-Key

Request body

item_idstring required

The DigiTax ID of the item whose stock is being adjusted.

quantitynumber required

The quantity of stock to add or deduct.

action'ADD' | 'DEDUCT' required

The stock adjustment action.

movement_typestring required

The code identifying the stock movement type.

Example request

{
  "item_id": "item_01HC3J1VVVM05YCTS61G7V3KC6",
  "quantity": 100,
  "action": "ADD",
  "movement_type": "01"
}

Response

Success

idstring required

The DigiTax ID of the item.

item_codestring required

The item code generated by DigiTax from the country of origin, item type, packaging unit, quantity unit, and an eight-digit sequence number.

stock_quantityinteger required

The item's stock quantity after the adjustment.

Example response

{
  "id": "item_01HC3J1VVVM05YCTS61G7V3KC6",
  "item_code": "KE1PD-U230411121122",
  "stock_quantity": 300
}

Changes

No recorded changes to this operation across all 2 revisions of this API.