API Docs
Adjust API
Adjust Inventory QTY Incremental

Adjust Inventory Qty Incremental API

Adjust Inventory Qty Incremental API is used in Warehouse Management System to incrementally adjust inventory quantities. This article introduces the general Adjust Inventory Qty Incremental API for easily understanding and applying this API.

Introduction

Adjust Inventory Qty Incremental API allows users to add or reduce quantity of specific items in the warehouse inventory based on operational needs, ,such as restocking, shrinkage or discrepancies. It ensures the system reflects real-time stock level.

API Request

API: POST /edi/3pl/adjust/inventory-adjust-qty-incremental
Body Request:

Body ParameterRequiredDescriptionNote
CompanyIDYCompany ID"LT"
CustomerIDYCustomer ID"AUKINT0001"
FacilityIDYFacility ID"889"
LPYLP ID
* LP and Location should not be both empty
"ILP-1000011"
LocationYLocation
* LP and Location should not be both empty
"01.001.002.3"
StatusNInventory Status[
"AVAILABLE"
"ON_HOLD"
]
TitleNItem Title
GoodsTypeNItem Goods Type[
"GOOD"
"DAMAGE"
]
LotNoNItem Lot Number
ExpirationDateNItem Expiration Date2023-01-01T00:00:00-07:00
MfgDateNItem MFG Date2023-01-01T00:00:00-07:00
ShelfLifeDateNItem Shelf Life Date2023-01-01T00:00:00-07:00
SNNItem SN
ItemIDYItem ID"SKU10001"
UOMYITEM UOM[
"EA"
"CS"
]
DeltaQtyYAdjustment In/Out Qty100
NoteNAdjustment Note
ReasonYAdjustment Reason[
"Cycle Count",
""CC Overage",
""CC Shortage",
""Physical Count",
]

API Return

It returns the status which indicates the operation is correct or not, for more detail, please refer to the following example.

Example

Available inventory 50 is updated with following request
Before: 50
After: 150

Request

{
  "CompanyID": "LT",
  "CustomerID": "AUKINT0001",
  "FacilityID": "889",
  "Location": "01.001.002.003",
  "ItemID": "SKU001",
  "LpID": "", 
  "Status": "AVAILABLE",
  "DeltaQty": 100,  // 100 for adjust in, -100 for adjust out
  "UOM": "EA",
  "ReasonCode": "Cycle Count",
  "Note": ""  //Optional
}

Response

// Success return 
200
{
	"success": true
}
// Failure return 
400
{
    "error": "something went wrong"
}