Stock Management

Stock management is the practice of ordering, storing, tracking, and controlling inventory.## Stock Object

Stock management applies to every item a business uses to produce its products or services – from raw materials to finished goods. In other words, stock management covers every aspect of a business’s inventory.

Attributes

---

StockTransferDto

Attribute	Type	Description
code	string	Unique code assigned to the stock transfer.
destWarehouseCode	string	Destination warehouse code assigned to the stock transfer.
destWarehouseName	string	Destination warehouse name assigned to the stock transfer.
notes	string
srcWarehouseCode	string	Source warehouse code assigned to the stock transfer.
srcWarehouseName	string	Source warehouse name assigned to the stock transfer.
stockTransferItems	list	Attribute for stockTransferItems
transferDate	string	Stock Transfer date.

StockAdjustmentDto

Attribute	Type	Description
adjustmentDate	string	Stock Adjustment
adjustmentReason	enum	Possible values for adjustmentReason
adjustmentType	enum	Possible values for adjustmentType
code	string	Unique code assigned to the stock adjustment.
notes	string
stockAdjustmentItems	list	Attribute for stockAdjustmentItems
totalValue	number
warehouseCode	string	Warehouse code for stock adjustment.
warehouseName	string	Warehouse name for stock adjustment.

API

---

Create Stock Transfer

Create new stock transfer.

Parameters

• stockTransferDto StockTransferDto
• accessToken string

Code

  @Autowired
  private InventoryClient inventoryClient;

  public StockTransferDto createStockTransfer(String accessToken, StockTransferDto stockTransferDto){
    return this.inventoryClient.createStockTransfer(accessToken, stockTransferDto);
  }

---

Retrive Stock Transfer

Retrieves the details of an existing Stock Transfer. You need only supply the unique code that was returned upon Stock Transfer creation.

Parameters

• accessToken string
• code string

Code

  @Autowired
  private InventoryClient inventoryClient;

  public StockTransferDto getStockTransferByCode(String accessToken, String code){
    return this.inventoryClient.getStockTransferByCode(accessToken, code);
  }

---

Update Stock Transfer

Update the details of an existing Stock Transfer.

Parameters

• accessToken string
• stockTransferRequest StockTransferRequest

Code

  @Autowired
  private InventoryClient inventoryClient;

  public StockTransferDto editStockTransferByCode(String accessToken, StockTransferRequest stockTransferRequest){
    return this.inventoryClient.editStockTransferByCode(accessToken, stockTransferRequest);
  }

---

List All Stock Transfer

Returns list of Stock Tarnsfer.

Parameters

• accessToken string

Code

  @Autowired
  private InventoryClient inventoryClient;

    public List<StockTransferDto> getStockTransferList(String accessToken){
    return this.inventoryClient.getStockTransferList(accessToken);
  } 

---

Search Stock Transfer

Search Stock Transfer.

Parameters

• accessToken string
• filterCriteria FilterCriteria

Code

  @Autowired
  private InventoryClient inventoryClient;

    public RestResponsePage searchStockTransferList(String accessToken, FilterCriteria filterCriteria){
    return this.inventoryClient.searchStockTransferList(accessToken, filterCriteria);
  }

---

Create Stock Adjustment

Create new atock Adjustment.

Parameters

• stockAdjustmentDto StockAdjustmentDto
• accessToken string

Code

  @Autowired
  private InventoryClient inventoryClient;

    public StockAdjustmentDto createStockAdjustment(String accessToken, StockAdjustmentDto stockAdjustmentDto){
    return this.inventoryClient.createStockAdjustment(accessToken, stockAdjustmentDto);
  }

---

Retrive Stock Adjustment

Retrieves the details of an existing Stock Adjustment. You need only supply the unique code that was returned upon Stock Adjustment creation.

Parameters

• accessToken string
• code string

Code

  @Autowired
  private InventoryClient inventoryClient;

    public StockAdjustmentDto getStockAdjustmentByCode(String accessToken, String code){
    return this.inventoryClient.getStockAdjustmentByCode(accessToken, code);
  }

---

Update Stock Adjustment

Update the details of an existing Stock Adjustment.

Parameters

• accessToken string
• stockAdjustmentRequest StockAdjustmentRequest

Code

  @Autowired
  private InventoryClient inventoryClient;

    public StockAdjustmentDto editStockAdjustmentByCode(String accessToken, StockAdjustmentRequest stockAdjustmentRequest){
    return this.inventoryClient.editStockAdjustmentByCode(accessToken, stockAdjustmentRequest);
  }

---

List All Stock Adjustment

Returns list of Stock Adjustment.

Parameters

• accessToken string

Code

  @Autowired
  private InventoryClient inventoryClient;

    public List<StockAdjustmentDto> getStockAdjustmentList(String accessToken){
    return this.inventoryClient.getStockAdjustmentList(accessToken);
  }

---

Search Stock Adjustment

Search Stock Adjustment.

Parameters

• accessToken string
• filterCriteria FilterCriteria

Code

  @Autowired
  private InventoryClient inventoryClient;

    public RestResponsePage<StockAdjustmentDto> searchStockAdjustmentList(String accessToken, FilterCriteria filterCriteria){
    return this.inventoryClient.searchStockAdjustmentList(accessToken, filterCriteria);
  }

---

Delete Stock Adjustment

Deletes an existing Stock Adjustment. You need only supply the unique code that was returned upon Stock Adjustment creation.

Parameters

• accessToken string
• code string

Code

  @Autowired
  private InventoryClient inventoryClient;

    public void deleteStockAdjustment(String accessToken, String code){
    this.inventoryClient.deleteStockAdjustment(accessToken, code);
  }

---

Objects

---

StockTransferItemDto

Attribute	Type	Description
productVariantCode	string
quantity	BigDecimal	Transfer quantity.
productName	string	Product name.

StockAdjustmentItemDto

Attribute	Type	Description
perUnitValue	BigDecimal	Per unit price of product.
productVariantCode	string
quantity	BigDecimal	Transfer quantity.
productName	string	Product name.

StockTransferRequest

Attribute	Type	Description
code	string	Unique code assigned to the stock transfer.
notes	string

StockAdjustmentRequest

Attribute	Type	Description
code	string	Unique code assigned to the stock adjustment.
reason	enum	Possible values for reason
notes	string

FilterCriteria

Attribute	Type	Description
fullTextSearch	string	Text to be searched.
query	string
page	int	Page no. to get records for particular page.
limit	int	Total no. of records should be displayed on current page.
sort	string
sortDir	string
fromDate	string
toDate	string
filter	string

RestResponsePage«StockAdjustmentDto»

Attribute	Type	Description
content	list	List of Stock Adjustment. Attribute for content
empty	boolean
first	boolean
last	boolean
number	int
numberOfElements	int
pageable	Pageable
size	int
sort	Sort
totalElements	long
totalPages	int

RestResponsePage«StockTransferDto»

Attribute	Type	Description
content	list	List of Stock Transfer. Attribute for content
empty	boolean
first	boolean
last	boolean
number	int
numberOfElements	int
pageable	Pageable
size	int
sort	Sort
totalElements	long
totalPages	int

Pageable

Attribute	Type	Description
offset	long
pageNumber	int
pageSize	int
paged	boolean
sort	Sort
unpaged	boolean

Sort

Attribute	Type	Description
empty	boolean
sorted	boolean
unsorted	boolean

---

Enums

---

ADJUSTMENT_TYPE

• STOCK_IN
• STOCK_OUT

ADJUSTMENT_REASON

• RETURNED
• PROMOTION
• STOCKTAKE
• DAMAGED
• SHRINKAGE
• OTHER