Stock

Transfer stock between businesses.

Transfers a specified quantity of stock from an item in the authenticated business to an item in the receiving business.

post/stock/transfer

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 from which stock will be deducted.

business_idstring required

The DigiTax ID of the business receiving the transferred stock.

quantitynumber required

The quantity of stock to transfer.

receiving_item_idstring required

The DigiTax ID of the item receiving the transferred stock.

Example request

{
  "item_id": "item_01HC3J1VVVM05YCTS61G7V3KC6",
  "business_id": "business_01HC3J1VVVM05YCTS61G7V3KC6",
  "quantity": 1,
  "receiving_item_id": "item_01J8HJFH3NG17EGVF0N5GHMPM9"
}

Response

Success

messagestring required

A message confirming that the operation succeeded.

Changes

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