Product APIs

Product describe the services or goods offering to your customers or vendors. For example, you might offer Essential and Premium version of your product. Offering of each version of your product would be separate product with different pricing.

ProductRequest help you to create a new product, and update a particular product.

API

Search Product

Get products by filter criteria. More about search product

Description:

Allows you to retrieve a list of all products.
Allows you to retrieve specific products based on it's filter criteria.

GET Product

/v1/products

Request URL

Product API documentation

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
productTransactionType	query	productTransactionType	No	string
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Create Product

Create a new product. More about create product

Description:

Allows you to create a new product.

POST

/v1/products

Request URL

Product API documentation

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Product has been created successfully.	ProductResponse
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Update Product

Update product information. More about update product

Description:

Allows you to update a specific product information.

PUT

Products {id}

Request URL

Product API documentation

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseIndia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

Get Products Paged

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
productTransactionType	query	productTransactionType	No	string
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Product has been created successfully.	ProductResponse
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products allproductbrief

GET

Summary

Get All product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products assign-batch

POST

Summary

assignBatchSerialToOpeningQuantity

Parameters

Name	Located in	Description	Required	Schema
assignBatchSerialRequest	body	assignBatchSerialRequest	Yes	AssignBatchSerialRequest

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Parameters

Name	Located in	Description	Required	Schema
productTransactionType	query	productTransactionType	No	string

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products brief-search

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products briefbyaccountcode/{accountCode}

GET

Summary

Get product brief information by account code.

Description

API to get the products by account code used as any of the following - Sales, Sales Return, Purchase, Purchase Return, COGS, Inventory, Stock Adjument account, GL account for India or GL account for MY.

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	Product brief information by account code have been fetched successfully.	[ ProductResponse ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products code/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
fetchImageUrls	query	fetchImageUrls	No	boolean
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products demo/{tenantId}

POST

Summary

Create demo Products.

Description

API to create demo products.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products getusedboms

POST

Summary

API to get used boms

Description

API to get used boms

Parameters

Name	Located in	Description	Required	Schema
pid	query	pid	Yes	string

Responses

Code	Description	Schema
200	API to get used boms successfully.	[ string ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ids

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequest ]

Responses

Code	Description	Schema
200	OK	[ ProductResponse ]
201	Products have been imported successfully.	[ ProductResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products info

POST

Summary

Fetch product details by codes

Description

Fetch product details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ProductInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Find Product Used

GET

Summary

To check if product is used

Description

API to check if product is used

Parameters

Name	Located in	Description	Required	Schema
productId	query	productId	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products isusedlandedcostcategory

POST

Summary

API to check used landed cost category

Description

To migrate in/out product qty

Parameters

Name	Located in	Description	Required	Schema
landedCostCategory	body	landedCostCategory	Yes	LandedCostCategory

Responses

Code	Description	Schema
200	Landed Cost Category checked successfully.	boolean
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products isusedoperations

POST

Summary

API to check used operations

Description

API to check used operations

Parameters

Name	Located in	Description	Required	Schema
operations	body	operations	Yes	[ long ]

Responses

Code	Description	Schema
200	API to check used operations checked successfully.	boolean
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products migrate-reorder

POST

Summary

To migrate in/out product qty

Description

API to migrate in/out product qty

Parameters

Name	Located in	Description	Required	Schema
productCodeList	body	productCodeList	Yes	[ string ]

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products opening-inventory-acc-codes

GET

Summary

Get Inventory Account Codes of Products with Opening Valuation

Description

API to Get Inventory Account Codes of Products with Opening Valuation

Responses

Code	Description	Schema
200	Inventory Account Codes of Products with Opening Valuation fetched successfully	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products product-custom-fields

POST

Summary

Get Custom Fields By Product Codes

Description

API to Get Custom Fields By Product Codes

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Custom Fields By Product Codes fetched successfully	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get Product short info

POST

Summary

getProductPrice

Parameters

Name	Located in	Description	Required	Schema
priceRequestList	body	priceRequestList	Yes	[ ProductShortInfoRequestForWorkOrder ]

Responses

Code	Description	Schema
200	OK	[ ProductShortInfoForWorkOrder ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products save-import-data

POST

Summary

/save-import-data

Description

API to save import data.

Parameters

Name	Located in	Description	Required	Schema
productDataRequest	body	productDataRequest	Yes	ImportDataRequest

Responses

Code	Description	Schema
200	OK	object
201	Import Data saved successfully	object
400	Error while saving import Data
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get Product Summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products tax/count

POST

Summary

Get Product count for tax

Description

API to fetch Product count for tax

Parameters

Name	Located in	Description	Required	Schema
taxCodes	body	taxCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Tax Product count has been fetched.	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products update-qty

POST

Summary

To update in/out product qty

Description

API to update in/out product qty

Parameters

Name	Located in	Description	Required	Schema
productInOutQtyList	body	productInOutQtyList	Yes	[ ProductInOutQty ]

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products variants

POST

Summary

Create product variants

Description

API to create new product variants

Parameters

Name	Located in	Description	Required	Schema
variantsCreateRequest	body	variantsCreateRequest	Yes	VariantsCreateRequest

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Variant has been created successfully.	ProductResponse
400	Variant creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products variants/attribute/validate

POST

Summary

validateAttributeEdit

Parameters

Name	Located in	Description	Required	Schema
variantAttributeValidateRequest	body	variantAttributeValidateRequest	Yes	VariantAttributeValidateRequest

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products variants/list

POST

Summary

Get products variants

Description

API to get product variants

Parameters

Name	Located in	Description	Required	Schema
masterProductIds	body	masterProductIds	Yes	[ long ]

Responses

Code	Description	Schema
200	Product variants have been fetched successfully.	ProductResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products variants/{id}

GET

Summary

Get products variants

Description

API to get product variants

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Product variants have been fetched successfully.	ProductResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product variant

Description

API to delete product variant

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	Product variant has been deleted successfully.
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Products {id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseIndia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

additional-charge-controller

Additional Charge Controller

Get Products Additonal Charges

GET

Summary

GET Additional Charges

Description

API to get all existing Additional Charges

Responses

Code	Description	Schema
200	Additional Charges have been fetched successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new additional charge.

Description

API to create new additional charges.

Parameters

Name	Located in	Description	Required	Schema
additionalChargeRequest	body	additionalChargeRequest	Yes	AdditionalChargeRequest

Responses

Code	Description	Schema
200	OK	AdditionalChargeResponse
201	Additional charge has been created successfully.	AdditionalChargeResponse
400	Additional charge creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products additional-charge/{id}

PUT

Summary

Update existing Additional Charge.

Description

API to update existing Additional Charge.

Parameters

Name	Located in	Description	Required	Schema
additionalChargeRequest	body	additionalChargeRequest	Yes	AdditionalChargeRequest
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Additional Charge has been updated successfully.	AdditionalChargeResponse
201	Created
401	Unauthorized
403	Forbidden
404	Additional Charge with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete Additional Charge.

Description

API to delete existing Additional Charge.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Additional Charge has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Additional Charge has not been found to delete

Security

Security Schema	Scopes
Authorization	global

product-controller-uae

Product UAE APIs

Products ae

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseUae
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequestUae

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Product has been created successfully.	ProductResponse
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products ae/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ae/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ae/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ae/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ae/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ae/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ae/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequestUae ]

Responses

Code	Description	Schema
200	OK	[ ProductResponse ]
201	Products have been imported successfully.	[ ProductResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ae/inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products ae/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ae/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ae/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequestUae

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseUae
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

bom-controller

Build Of Materials APIs

Products assemble

POST

Summary

Assemble Bill_Of_Materials product

Description

API to assemble Bill_Of_Materials product

Parameters

Name	Located in	Description	Required	Schema
productCode	query	productCode	Yes	string
quantity	query	quantity	Yes	number
warehouseCode	query	warehouseCode	Yes	string

Responses

Code	Description
200	Product has been assembled successfully
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
406	Product can not be assembled due to insufficient quantity

Security

Security Schema	Scopes
Authorization	global

Products assemble/addworkorderinventory

POST

Summary

Work Order Inventory

Description

add Work Order Inventory details

Parameters

Name	Located in	Description	Required	Schema
req	body	req	Yes	WorkOrderInventoryRequest

Responses

Code	Description	Schema
200	Work order details added in inventory successfully	BomAssemblyResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
406	Work order details could not be added in inventory.

Security

Security Schema	Scopes
Authorization	global

Products assemble/bom-je

POST

Summary

updateBOMJE

Parameters

Name	Located in	Description	Required	Schema
bomCodes	body	bomCodes	Yes	[ string ]

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products assemble/bomProductCost

GET

Summary

getBomProductCost

Parameters

Name	Located in	Description	Required	Schema
bomSeqCode	query	bomSeqCode	Yes	string

Responses

Code	Description	Schema
200	OK	object
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products assemble/bomassemble

POST

Summary

Assemble Bill_Of_Materials product

Description

API to assemble Bill_Of_Materials product

Parameters

Name	Located in	Description	Required	Schema
req	body	req	Yes	BomAssemblyRequest

Responses

Code	Description	Schema
200	Product has been assembled successfully	BomAssemblyResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
406	Product can not be assembled due to insufficient quantity

Security

Security Schema	Scopes
Authorization	global

Products assemble/bomconsumtionproductiondetails

GET

Summary

getBOMConsumptionProductionSummary

Parameters

Name	Located in	Description	Required	Schema
bomMetaCode	query	bomMetaCode	No	string
productCode	query	productCode	Yes	string
workOrderCode	query	workOrderCode	Yes	string

Responses

Code	Description	Schema
200	OK	WIPConsumptionProductionSummaryDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products assemble/bomdetails

GET

Summary

getBOMAssemblyDetails

Parameters

Name	Located in	Description	Required	Schema
bomMetaCode	query	bomMetaCode	No	string
productId	query	productId	Yes	long
quantityToBuild	query	quantityToBuild	Yes	number

Responses

Code	Description	Schema
200	OK	BOMAssemblyDetailsResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products assemble/bomexplosiondetails

GET

Summary

getBOMExplosionDetails

Parameters

Name	Located in	Description	Required	Schema
bomMetaCode	query	bomMetaCode	No	string
productCode	query	productCode	Yes	string

Responses

Code	Description	Schema
200	OK	BomExplosionDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products assemble/productforecasedetails

GET

Summary

getProductForecastDetails

Parameters

Name	Located in	Description	Required	Schema
bomMetaCode	query	bomMetaCode	No	string
productCode	query	productCode	Yes	string

Responses

Code	Description	Schema
200	OK	[ ProductForecastDetailsDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products assemble/quantity

GET

Summary

Get max assemble quantity for product

Description

API to get max assemble quantity

Parameters

Name	Located in	Description	Required	Schema
productCode	query	productCode	Yes	string
warehouseCode	query	warehouseCode	Yes	string

Responses

Code	Description	Schema
200	Max assemble quantity has been fetched successfully	integer
400	Warehouse Code is missing
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

attribute-controller

Attributes APIs

Get Product Attributes

GET

Summary

Search attribute.

Description

API to search attribute.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Attribute has been fethced successfully.	ProductResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new attribute.

Description

API to create new attribute.

Parameters

Name	Located in	Description	Required	Schema
attributeRequest	body	attributeRequest	Yes	AttributeRequest

Responses

Code	Description	Schema
200	OK	AttributeRequest
201	Attribute has been created successfully.	AttributeRequest
400	Attribute creation failed
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products attribute/bulk

POST

Summary

Create new attribute.

Description

API to create new attribute.

Parameters

Name	Located in	Description	Required	Schema
attributeRequestList	body	attributeRequestList	Yes	[ AttributeRequest ]

Responses

Code	Description
200	OK
201	Attribute has been created successfully.
400	Attribute creation failed
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products attribute/{id}

DELETE

Summary

Delete attribute.

Description

API to delete attribute.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
201	Attribute has been deleted successfully.
204	No Content
400	Attribute deletion failed
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

product-controller-australia

v1/products/au

Products au

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Product has been created successfully.	ProductResponse
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products au/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/briefbyaccountcode/{accountCode}

GET

Summary

Get product brief information by account code.

Description

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	Product brief information by account code have been fetched successfully.	[ ProductResponse ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/code/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/demo/{tenantId}

POST

Summary

Create demo Products.

Description

API to create demo products.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequest ]

Responses

Code	Description	Schema
200	OK	[ ProductResponse ]
201	Products have been imported successfully.	[ ProductResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/info

POST

Summary

Fetch product details by codes

Description

Fetch product details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ProductInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products au/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/opening-inventory-acc-codes

GET

Summary

Get Inventory Account Codes of Products with Opening Valuation

Description

API to Get Inventory Account Codes of Products with Opening Valuation

Responses

Code	Description	Schema
200	Inventory Account Codes of Products with Opening Valuation fetched successfully	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products au/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseIndia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

barcode-controller

Barcode Controller

Products barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new Product Barcode Info.

Description

API to create new Product Barcode Info.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	UOMDto
201	API to create new Product Barcode Info.	UOMDto
400	Product Barcode Info creation failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

product-controller-be

Product Belgium APIs

Products be

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Product has been created successfully.	ProductResponse
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products be/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/briefbyaccountcode/{accountCode}

GET

Summary

Get product brief information by account code.

Description

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	Product brief information by account code have been fetched successfully.	[ ProductResponse ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/code/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/demo/{tenantId}

POST

Summary

Create demo Products.

Description

API to create demo products.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequest ]

Responses

Code	Description	Schema
200	OK	[ ProductResponse ]
201	Products have been imported successfully.	[ ProductResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/info

POST

Summary

Fetch product details by codes

Description

Fetch product details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ProductInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products be/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/opening-inventory-acc-codes

GET

Summary

Get Inventory Account Codes of Products with Opening Valuation

Description

API to Get Inventory Account Codes of Products with Opening Valuation

Responses

Code	Description	Schema
200	Inventory Account Codes of Products with Opening Valuation fetched successfully	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products be/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseIndia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

product-controller-canada

v1/products/ca

Products ca

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Product has been created successfully.	ProductResponse
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products ca/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/briefbyaccountcode/{accountCode}

GET

Summary

Get product brief information by account code.

Description

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	Product brief information by account code have been fetched successfully.	[ ProductResponse ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/code/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/demo/{tenantId}

POST

Summary

Create demo Products.

Description

API to create demo products.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequest ]

Responses

Code	Description	Schema
200	OK	[ ProductResponse ]
201	Products have been imported successfully.	[ ProductResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/info

POST

Summary

Fetch product details by codes

Description

Fetch product details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ProductInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products ca/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/opening-inventory-acc-codes

GET

Summary

Get Inventory Account Codes of Products with Opening Valuation

Description

API to Get Inventory Account Codes of Products with Opening Valuation

Responses

Code	Description	Schema
200	Inventory Account Codes of Products with Opening Valuation fetched successfully	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ca/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseIndia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

product-controller-germany

v1/products/de

Products de

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Product has been created successfully.	ProductResponse
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products de/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/briefbyaccountcode/{accountCode}

GET

Summary

Get product brief information by account code.

Description

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	Product brief information by account code have been fetched successfully.	[ ProductResponse ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/code/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/demo/{tenantId}

POST

Summary

Create demo Products.

Description

API to create demo products.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequest ]

Responses

Code	Description	Schema
200	OK	[ ProductResponse ]
201	Products have been imported successfully.	[ ProductResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/info

POST

Summary

Fetch product details by codes

Description

Fetch product details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ProductInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products de/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/opening-inventory-acc-codes

GET

Summary

Get Inventory Account Codes of Products with Opening Valuation

Description

API to Get Inventory Account Codes of Products with Opening Valuation

Responses

Code	Description	Schema
200	Inventory Account Codes of Products with Opening Valuation fetched successfully	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products de/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseIndia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

fulfillment-controller

Fulfillment APIs

Products fulfillment

GET

Summary

Search Fulfillment Order

Description

API to search Fulfillment Order

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Fulfillment orders have been fetched successfully.	FulfillmentResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Fulfilled Sales Order.

Description

API to create sales order item fulfillment.

Parameters

Name	Located in	Description	Required	Schema
fulfillmentRequest	body	fulfillmentRequest	Yes	FulfillmentRequest

Responses

Code	Description	Schema
200	Fulfillment has been created successfully.	FulfillmentResponse
201	Created
400	Fulfillment not created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete fulfillment by fulfillment code.

Description

API to delete fulfillment by fulfillment code.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCode	query	documentSequenceCode	Yes	string
fulfillmentCode	query	fulfillmentCode	Yes	string
isBulkDelete	query	isBulkDelete	No	boolean
isConvertedFromQuotation	query	isConvertedFromQuotation	Yes	boolean
salesInvoiceCode	query	salesInvoiceCode	Yes	string

Responses

Code	Description
200	OK
204	Fulfillment has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Fulfillment could not be deleted.

Security

Security Schema	Scopes
Authorization	global

Products fulfillment/DeleteAllFulfillment

DELETE

Summary

Delete all fulfillment by tenant Id

Description

API to delete all fulfillment by tenant Id

Parameters

Name	Located in	Description	Required	Schema
tenantId	query	tenantId	Yes	long

Responses

Code	Description
200	OK
204	Fulfillment has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Fulfillment could not be deleted.

Security

Security Schema	Scopes
Authorization	global

Products fulfillment/bulk

POST

Summary

Fulfilled Sales Order.

Description

API to create bulk sales order item fulfillment.

Parameters

Name	Located in	Description	Required	Schema
fulfillmentRequests	body	fulfillmentRequests	Yes	[ FulfillmentRequest ]

Responses

Code	Description	Schema
200	Fulfillment has been created successfully.	[ FulfillmentResponse ]
201	Created
400	Fulfillment not created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get Product Fulfillment based on code and type

GET

Summary

Get fulfillment details by document code. Document can be at any stage (QUOTATION or INVOICE)

Description

API to fetch fulfillment details by document code.

Parameters

Name	Located in	Description	Required	Schema
documentCode	path	documentCode	Yes	string
documentType	query	documentType	Yes	string

Responses

Code	Description	Schema
200	Fulfillment information fetched successfully.	[ FulfillmentResponse ]
401	Unauthorized
403	Forbidden
404	Fulfillment not found.

Security

Security Schema	Scopes
Authorization	global

Products fulfillment/fulfillmentitems/{code}

GET

Summary

Get fulfillment details by fulfillment code.

Description

API to fetch fulfillment details by fulfillment code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Fulfillment information fetched successfully.	FulfillmentResponse
401	Unauthorized
403	Forbidden
404	Fulfillment item not found.

Security

Security Schema	Scopes
Authorization	global

Products fulfillment/quantity

POST

Summary

getQuoteAndInvoiceQuantities

Parameters

Name	Located in	Description	Required	Schema
request	body	request	Yes	StockQuantitiesRequest

Responses

Code	Description	Schema
200	OK	StockQuantitiesResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products fulfillment/quotation

DELETE

Summary

Delete fulfillment of Quotation by fulfillment code.

Description

API to delete fulfillment of Quotation by fulfillment code.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCode	query	documentSequenceCode	Yes	string
fulfillmentCode	query	fulfillmentCode	Yes	string
isBulkDelete	query	isBulkDelete	No	boolean
quotationCode	query	quotationCode	Yes	string

Responses

Code	Description
200	OK
204	API to delete fulfillment of Quotation by fulfillment code.
401	Unauthorized
403	Forbidden
404	Fulfillment of Quotation could not be deleted.

Security

Security Schema	Scopes
Authorization	global

Products fulfillment/salesorder

DELETE

Summary

Delete fulfillment by fulfillment code.

Description

API to delete fulfillment by fulfillment code.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCode	query	documentSequenceCode	Yes	string
fulfillmentCode	query	fulfillmentCode	Yes	string
isBulkDelete	query	isBulkDelete	No	boolean
isConvertedFromQuotation	query	isConvertedFromQuotation	Yes	boolean
salesOrderCode	query	salesOrderCode	Yes	string

Responses

Code	Description
200	OK
204	Fulfillment has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Fulfillment could not be deleted.

Security

Security Schema	Scopes
Authorization	global

Products fulfillment/{code}

GET

Summary

Get fulfillment details by fulfillment code.

Description

API to fetch fulfillment details by fulfillment code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Fulfillment information fetched successfully.	FulfillmentResponse
401	Unauthorized
403	Forbidden
404	Fulfillment not found.

Security

Security Schema	Scopes
Authorization	global

Products fulfillment/{code}/bulk

GET

Summary

Get fulfillment details by fulfillment code.

Description

API to fetch fulfillment details by fulfillment code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Fulfillment information fetched successfully.	FulfillmentResponse
401	Unauthorized
403	Forbidden
404	Fulfillment not found.

Security

Security Schema	Scopes
Authorization	global

Products fulfillment/{id}

DELETE

Summary

Delete fulfillment by fulfillment id.

Description

API to delete fulfillment by fulfillment id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Fulfillment has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Fulfillment not found.

Security

Security Schema	Scopes
Authorization	global

goods-receipt-controller

Goods Receipts APIs

Add Product Goods receipt

POST

Summary

Goods receipt purchase Order.

Description

API to create goods receipt purchase Order.

Parameters

Name	Located in	Description	Required	Schema
goodsReceiptRequest	body	goodsReceiptRequest	Yes	GoodsReceiptRequest

Responses

Code	Description	Schema
200	Purchase order item goods receipt has been created successfully.	GoodsReceiptResponse
201	Created
400	Purchase order item goods receipt failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products goodsreceipt/DeleteAllGoodReceipt

DELETE

Summary

Delete all purchase order Goods receipt by tenant Id.

Description

API to delete all purchase order Goods receipt by tenant Id.

Parameters

Name	Located in	Description	Required	Schema
tenantId	query	tenantId	Yes	long

Responses

Code	Description
200	OK
204	Goods receipt has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order Goods receipt not found

Security

Security Schema	Scopes
Authorization	global

Products goodsreceipt/codes-types

POST

Summary

Fetch Goods receipts for documents

Description

API to Fetch Goods receipts for documents

Parameters

Name	Located in	Description	Required	Schema
goodsReceiptRequest	body	goodsReceiptRequest	Yes	GoodsReceiptsTypeCodeRequest

Responses

Code	Description	Schema
200	Goods receipts for documents fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products goodsreceipt/count/{code}

GET

Summary

Get number of GRs by parent code

Description

Get number of GRs by parent code

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	GR count fetched by code	integer
401	Unauthorized
403	Forbidden
404	GR count with code not found

Security

Security Schema	Scopes
Authorization	global

Products goodsreceipt/documentCode/{documentCode}

GET

Summary

Get goods receipt details by document code.

Description

API to fetch purchase order item goods receipt details by document code.

Parameters

Name	Located in	Description	Required	Schema
documentCode	path	documentCode	Yes	string
documentType	query	documentType	Yes	string

Responses

Code	Description	Schema
200	Purchase order item goods receipt information fetched successfully.	[ GoodsReceiptResponse ]
401	Unauthorized
403	Forbidden
404	Purchase order goods receipt not found.

Security

Security Schema	Scopes
Authorization	global

Products goodsreceipt/items/{code}

GET

Summary

Get GR ITEM by code

Description

Get GR ITEM by code

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	GR fetched by code	GoodsReceiptItemDto
401	Unauthorized
403	Forbidden
404	GR with code not found

Security

Security Schema	Scopes
Authorization	global

Products goodsreceipt/receipt

DELETE

Summary

Delete Purchase Invoice Goods receipt by goodsReceipt code.

Description

API to delete Purchase Invoice Goods Receipt by goodsReceipt code.

Parameters

Name	Located in	Description	Required	Schema
goodsReceiptCode	query	goodsReceiptCode	Yes	string
isBulkDeleted	query	isBulkDeleted	No	boolean
isConvertedFromOrder	query	isConvertedFromOrder	Yes	boolean
purchaseInvoiceCode	query	purchaseInvoiceCode	Yes	string

Responses

Code	Description
200	OK
204	Goods receipt has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase Invoice Goods receipt not found

Security

Security Schema	Scopes
Authorization	global

Products goodsreceipt/receipt/bulk

POST

Summary

Goods receipt purchase Order.

Description

API to create bulk goods receipt purchase Order.

Parameters

Name	Located in	Description	Required	Schema
goodsReceiptRequests	body	goodsReceiptRequests	Yes	[ GoodsReceiptRequest ]

Responses

Code	Description	Schema
200	Purchase order item goods receipt has been created successfully.	[ GoodsReceiptResponse ]
201	Created
400	Purchase order item goods receipt failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products goodsreceipt/receipt/order

DELETE

Summary

Delete Purchase Order Goods receipt by goodsReceipt code.

Description

API to delete Purchase Order Goods Receipt by goodsReceipt code.

Parameters

Name	Located in	Description	Required	Schema
goodsReceiptCode	query	goodsReceiptCode	Yes	string
isBulkDeleted	query	isBulkDeleted	No	boolean
purchaseOrderCode	query	purchaseOrderCode	Yes	string

Responses

Code	Description
200	OK
204	Goods receipt has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order Goods receipt not found

Security

Security Schema	Scopes
Authorization	global

Products goodsreceipt/receipt/{code}

GET

Summary

Get Goods receipt details by goods receipt code.

Description

API to fetch Goods receipt details by fulfillment code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Goods receipt information fetched successfully.	GoodsReceiptResponse
401	Unauthorized
403	Forbidden
404	Purchase order Goods receipt not found

Security

Security Schema	Scopes
Authorization	global

Products goodsreceipt/receipt/{code}/bulk

GET

Summary

Get Goods receipt details by goods receipt code.

Description

API to fetch Goods receipt details by fulfillment code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Goods receipt information fetched successfully.	GoodsReceiptResponse
401	Unauthorized
403	Forbidden
404	Purchase order Goods receipt not found

Security

Security Schema	Scopes
Authorization	global

Products goodsreceipt/receipt/{id}

DELETE

Summary

Delete purchase order Goods receipt by goodsReceipt Id.

Description

API to delete purchase order Goods Receipt by goodsReceipt Id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Goods receipt has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Purchase order Goods receipt not found

Security

Security Schema	Scopes
Authorization	global

Products goodsreceipt/{code}

GET

Summary

Get GR by code

Description

Get GR by code

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	GR fetched by code	GoodsReceiptResponse
401	Unauthorized
403	Forbidden
404	GR with code not found

Security

Security Schema	Scopes
Authorization	global

product-controller-indonesia

Product Indonesia APIs

Products id

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseIndonesia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequestIndonesia

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Product has been created successfully.	ProductResponse
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products id/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products id/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products id/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products id/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products id/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products id/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products id/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequestIndonesia ]

Responses

Code	Description	Schema
200	OK	[ ProductResponse ]
201	Products have been imported successfully.	[ ProductResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products id/inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products id/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products id/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products id/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequestIndonesia

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseIndonesia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

product-controller-india

Product India APIs

Products in

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
productTransactionType	query	productTransactionType	No	string
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequestIndia	body	productRequestIndia	Yes	ProductRequestIndia

Responses

Code	Description	Schema
200	OK	ProductResponseIndia
201	Product has been created successfully.	ProductResponseIndia
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products in/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products in/all-hsn-sac

GET

Summary

Fetch all HSN and SAC codes information

Description

API to get all HSN and SAC codes information

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	All HSN and SAC codes information have been fetched successfully.	HSNAndSACCode
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products in/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products in/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products in/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products in/codes

POST

Summary

getByCodes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ProductResponseIndia ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products in/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products in/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get Products HSN

GET

Summary

Fetch HSN code information

Description

API to get HSN code information

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	HSN code information have been fetched successfully.	HSNCodeIndiaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

API to create HSN

Description

API to create HSN

Parameters

Name	Located in	Description	Required	Schema
hsnCodeRequest	body	hsnCodeRequest	Yes	HSNCodeRequest

Responses

Code	Description	Schema
200	HSN successfully created	HSNCodeIndiaDto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products in/hsn/{code}

PUT

Summary

API to update HSN

Description

API to update HSN

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string
hsnCodeRequest	body	hsnCodeRequest	Yes	HSNCodeRequest

Responses

Code	Description	Schema
200	HSN successfully updated	HSNCodeIndiaDto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

API to delete HSN

Description

API to delete HSN

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	HSN succesfully deleted	SACCodeIndiaDto
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Products in/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequestIndia ]

Responses

Code	Description	Schema
200	OK	[ ProductResponseIndia ]
201	Products have been imported successfully.	[ ProductResponseIndia ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Update Product inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products in/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get Product SAC

GET

Summary

Fetch SAC code information

Description

API to get SAC code information

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	SAC code information have been fetched successfully.	SACCodeIndiaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

API to create SAC

Description

API to create SAC

Parameters

Name	Located in	Description	Required	Schema
sacCodeRequest	body	sacCodeRequest	Yes	SACCodeRequest

Responses

Code	Description	Schema
200	SAC successfully created	SACCodeIndiaDto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products in/sac/{code}

PUT

Summary

API to update SAC

Description

API to update SAC

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string
sacCodeRequest	body	sacCodeRequest	Yes	SACCodeRequest

Responses

Code	Description	Schema
200	SAC successfully updated	SACCodeIndiaDto
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

API to delete SAC

Description

SAC succesfully deleted

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	All HSN and SAC codes information have been fetched successfully.	SACCodeIndiaDto
204	No Content
401	Unauthorized
403	Forbidden

Security

Security Schema	Scopes
Authorization	global

Products in/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get product nature of payment

GET

Summary

Get TDS Nature of Payments.

Description

Get TDS Nature of Payments.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Fetched TDS Nature of Payments successfully.	TdsNatureOfPaymentIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create India Compliance TDS Nature of Payment.

Description

Create India Compliance TDS Nature of Payment.

Parameters

Name	Located in	Description	Required	Schema
tdsNatureOfPaymentIndiaRequest	body	tdsNatureOfPaymentIndiaRequest	Yes	TdsNatureOfPaymentIndiaRequest

Responses

Code	Description	Schema
200	OK	TdsNatureOfPaymentIndia
201	TDS Nature of Payment created successfully.	TdsNatureOfPaymentIndia
400	TDS Nature of Payment creation failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update India Compliance TDS Nature of Payment.

Description

Update India Compliance TDS Nature of Payment.

Parameters

Name	Located in	Description	Required	Schema
tdsNatureOfPaymentIndiaRequest	body	tdsNatureOfPaymentIndiaRequest	Yes	TdsNatureOfPaymentIndiaRequest

Responses

Code	Description	Schema
200	OK	TdsNatureOfPaymentIndia
201	TDS Nature of Payment updated successfully.	TdsNatureOfPaymentIndia
400	TDS Nature of Payment updation failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete TDS Nature of Payment.

Description

Delete TDS Nature of Payment.

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	TDS Nature of Payment has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Nature of Payment with id %s not found.

Security

Security Schema	Scopes
Authorization	global

Products in/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequestIndia	body	productRequestIndia	Yes	ProductRequestIndia

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseIndia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponseIndia
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

advanced-tracking-controller

Advanced Tracking APIs

Products inventories/advanced-tracking/available-serial-batch-by-warehouse

GET

Summary

Get Unfulfiled, Active Serial Numbers count

Description

API to Get Unfulfiled and Active Serial Numbers count

Parameters

Name	Located in	Description	Required	Schema
productCode	query	productCode	Yes	string
requiredQty	query	requiredQty	No	integer

Responses

Code	Description	Schema
200	Successfuly calculated number of serial/batches.	AdvancedTrackingCountBySerialBatchDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/advanced-tracking/document

GET

Summary

API to get product tracking information for a document

Description

API to get product tracking information for a document

Parameters

Name	Located in	Description	Required	Schema
document_code	query	document_code	Yes	string
document_type	query	document_type	Yes	string

Responses

Code	Description	Schema
200	Fetched product tracking information by document	[ ProductTrackingInfo ]
400	Failed to fetch product tracking information by document
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/advanced-tracking/document/fulfillment

POST

Summary

Get Document Tracking Inventory Info

Description

API to Get Document Tracking Inventory Info

Parameters

Name	Located in	Description	Required	Schema
document_code	query	document_code	Yes	string
document_type	query	document_type	Yes	string
fulfillmentItemCodes	body	fulfillmentItemCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Successfuly fetched tracking information by document.	AdvancedTrackingMeta
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get Product sales return based on code and type

POST

Summary

Get Document Tracking Inventory Info for return

Description

API to Get Document Tracking Inventory Info for return

Parameters

Name	Located in	Description	Required	Schema
document_code	query	document_code	Yes	string
document_type	query	document_type	Yes	string

Responses

Code	Description	Schema
200	Successfuly fetched tracking information by document for return.	AdvancedTrackingMeta
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/advanced-tracking/documentref

POST

Summary

Get Document Tracking Inventory Info

Description

API to Get Document Tracking Inventory Info

Parameters

Name	Located in	Description	Required	Schema
transactionRefCode	body	transactionRefCode	Yes	[ string ]

Responses

Code	Description	Schema
200	Successfuly fetched tracking information by document.	AdvancedTrackingMeta
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/advanced-tracking/fulfillment/search

GET

Summary

search Advanced Tracking Units for fulfillment by transactionRefCode

Description

API to search Advanced Tracking Units By Transaction Reference Code for Fulfillment

Parameters

Name	Located in	Description	Required	Schema
fromDate	query	fromDate	No	dateTime
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string
toDate	query	toDate	No	dateTime
transactionRefCode	query	transactionRefCode	Yes	string

Responses

Code	Description	Schema
200	Advanced Tracked Units for the fulfillment have been fetched successfully.	AdvancedTrackingMetaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/advanced-tracking/goods-received/search

GET

Summary

search Advanced Tracking Units for goods received by transactionRefCode

Description

API to search Advanced Tracking Units By Transaction Reference Code for Goods Received

Parameters

Name	Located in	Description	Required	Schema
fromDate	query	fromDate	No	dateTime
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string
toDate	query	toDate	No	dateTime
transactionRefCode	query	transactionRefCode	Yes	string

Responses

Code	Description	Schema
200	Advanced Tracked Units for goods received have been fetched successfully.	AdvancedTrackingMetaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/advanced-tracking/goods-received/txnCodes

POST

Summary

All advance tracking meta data

Description

Get all advance tracking meta data by goods receipt transactions

Parameters

Name	Located in	Description	Required	Schema
txnRefCodes	body	txnRefCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Successfuly fetched tracking information by document.	AdvancedTrackingMeta
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/advanced-tracking/search

GET

Summary

Search Advanced Tracking Units

Description

API to search Advanced Tracking Units

Parameters

Name	Located in	Description	Required	Schema
fromDate	query	fromDate	No	dateTime
isCombined	query	isCombined	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string
toDate	query	toDate	No	dateTime

Responses

Code	Description	Schema
200	Advanced Tracked Units have been fetched successfully.	AdvancedTrackingMetaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/advanced-tracking/serial-batch-count

GET

Summary

Get Unfulfiled, Active Serial Numbers count

Description

API to Get Unfulfiled and Active Serial Numbers count

Parameters

Name	Located in	Description	Required	Schema
productVariantCode	query	productVariantCode	Yes	string

Responses

Code	Description	Schema
200	Successfuly calculated number of serial/batches.	AdvancedTrackingCountBySerialBatchDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

pick-pack-ship-controller

Pick Pack Ship Controller

Products inventories/documents

GET

Summary

Search sales documents.

Description

API to search sales documents.

Parameters

Name	Located in	Description	Required	Schema
filter	query	filter	No	string
fromDate	query	fromDate	No	dateTime
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string
toDate	query	toDate	No	dateTime

Responses

Code	Description	Schema
200	Sales documents have been fetched successfully.	Page
400	Failed to fetch sales documents.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/documents/pick-pack-ship

PATCH

Summary

Update PPS document status.

Description

API to update PPS document status.

Parameters

Name	Located in	Description	Required	Schema
salesDocumentDtos	body	salesDocumentDtos	Yes	[ SalesDocumentDto ]
status	query	status	Yes	string

Responses

Code	Description
200	Status updated successfully.
204	No Content
401	Unauthorized
403	Forbidden
404	PPS Sales Document code not found.

Security

Security Schema	Scopes
Authorization	global

Products inventories/documents/processed/documents

POST

Summary

Get processed shipment document by quotation code.

Description

API to check shipment document is processed or not by quotation code.

Parameters

Name	Located in	Description	Required	Schema
documentCodes	body	documentCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Processed shipment document details have been fetched successfully.	[ ShipmentDocumentStatusDto ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/documents/shipment-details/bulk

POST

Summary

Get Shipment details.

Description

API for Shipment details.

Parameters

Name	Located in	Description	Required	Schema
requestDetails	body	requestDetails	Yes	ShipDocumentDetailRequestDto

Responses

Code	Description	Schema
200	Shipment details has been fetched successfully.	[ ShippingDocumentDto ]
201	Created
400	Failed to fetch Shipment details.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

pack-list-controller

Pack List Controller

Products inventories/pack-list

POST

Summary

Create Pack List.

Description

API to create pack list.

Parameters

Name	Located in	Description	Required	Schema
packListRequest	body	packListRequest	Yes	PackListRequest

Responses

Code	Description	Schema
200	OK	PicklistResponse
201	Pack list has been created successfully.	PicklistResponse
400	Pack list could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update Pack List.

Description

API to update existing pack list

Parameters

Name	Located in	Description	Required	Schema
packListRequest	body	packListRequest	Yes	PackListRequest

Responses

Code	Description	Schema
200	Pack List has been updated successfully.	PicklistResponse
201	Created
401	Unauthorized
403	Forbidden
404	Pack List with given id not found.

Security

Security Schema	Scopes
Authorization	global

Products inventories/pack-list/packlist-details

POST

Summary

print Packing Slip

Description

Api to print Packing Slip after passing documentCodes.

Parameters

Name	Located in	Description	Required	Schema
salesDocumentDtos	body	salesDocumentDtos	Yes	[ SalesDocumentDto ]

Responses

Code	Description	Schema
200	Selected Packing Slips has been printed successfully.	Resource
201	Created
401	Unauthorized
403	Forbidden
404	Order not found. %s

Security

Security Schema	Scopes
Authorization	global

Products inventories/pack-list/print

POST

Summary

print Packing Slip

Description

Api to print Packing Slip after passing documentCodes.

Parameters

Name	Located in	Description	Required	Schema
salesDocumentDtos	body	salesDocumentDtos	Yes	[ SalesDocumentDto ]

Responses

Code	Description	Schema
200	Selected Packing Slips has been printed successfully.	Resource
201	Created
401	Unauthorized
403	Forbidden
404	Order not found. %s

Security

Security Schema	Scopes
Authorization	global

Products inventories/pack-list/void

PUT

Summary

void pack list

Description

Api to void packlist after passing documentIds.

Parameters

Name	Located in	Description	Required	Schema
salesDocumentDtos	body	salesDocumentDtos	Yes	[ SalesDocumentDto ]

Responses

Code	Description
200	Selected packlists has been voided successfully.
201	Created
400	packlists can not be voided.
401	Unauthorized
403	Forbidden
404	Order not found. %s

Security

Security Schema	Scopes
Authorization	global

pick-list-controller

Pick List Controller

Products inventories/pick-list

GET

Summary

Search Pick List.

Description

API to fetch pick list.

Parameters

Name	Located in	Description	Required	Schema
filter	query	filter	No	string
fromDate	query	fromDate	No	dateTime
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string
toDate	query	toDate	No	dateTime

Responses

Code	Description	Schema
200	Pick list has been fetched successfully.	PicklistResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Pick List.

Description

API to create pick list.

Parameters

Name	Located in	Description	Required	Schema
pickListRequest	body	pickListRequest	Yes	PickListRequest

Responses

Code	Description	Schema
200	OK	PicklistResponse
201	Pick list has been created successfully.	PicklistResponse
400	Pick list could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/pick-list/picklist-details

POST

Summary

print Pick list

Description

Api to print picklist after passing picklistIds.

Parameters

Name	Located in	Description	Required	Schema
pickListIds	body	pickListIds	Yes	[ string ]

Responses

Code	Description	Schema
200	Selected picklists has been printed successfully.	Resource
201	Created
401	Unauthorized
403	Forbidden
404	Shipments by code not found. PickListCodes: %s

Security

Security Schema	Scopes
Authorization	global

Products inventories/pick-list/print

POST

Summary

print Pick list

Description

Api to print picklist after passing picklistIds.

Parameters

Name	Located in	Description	Required	Schema
pickListIds	body	pickListIds	Yes	[ string ]

Responses

Code	Description	Schema
200	Selected picklists has been printed successfully.	Resource
201	Created
401	Unauthorized
403	Forbidden
404	Shipments by code not found. PickListCodes: %s

Security

Security Schema	Scopes
Authorization	global

Products inventories/pick-list/sales-orders

POST

Summary

Get Details of selected order to create Pick list.

Description

Api to get details of selected orders.

Parameters

Name	Located in	Description	Required	Schema
salesDocumentDtos	body	salesDocumentDtos	Yes	[ SalesDocumentDto ]

Responses

Code	Description	Schema
200	Order details for pick list generation has been fetched successfully.	PicklistResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/pick-list/scan/{itemCode}/{barcode}

PUT

Summary

Scan product .

Description

API to scan product for selected order

Parameters

Name	Located in	Description	Required	Schema
barcode	path	barcode	Yes	string
itemCode	path	itemCode	Yes	string

Responses

Code	Description
200	Product has been scanned
201	Created
401	Unauthorized
403	Forbidden
404	Product not found

Security

Security Schema	Scopes
Authorization	global

Products inventories/pick-list/void

PUT

Summary

void Pick list

Description

Api to void picklist after passing picklistIds.

Parameters

Name	Located in	Description	Required	Schema
pickListIds	body	pickListIds	Yes	[ string ]

Responses

Code	Description
200	Selected picklists has been voided successfully.
201	Created
400	Picklists can not be voided.
401	Unauthorized
403	Forbidden
404	Shipments by code not found. PickListCodes: %s

Security

Security Schema	Scopes
Authorization	global

Products inventories/pick-list/{id}

PUT

Summary

Update Pick List.

Description

API to update existing pick list

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
pickListRequest	body	pickListRequest	Yes	PickListRequest

Responses

Code	Description	Schema
200	Pick List has been updated successfully.	PicklistResponse
201	Created
401	Unauthorized
403	Forbidden
404	Pick List with given id not found.

Security

Security Schema	Scopes
Authorization	global

reorder-report-controller

Reorder Report Controller

Products inventories/reorderreport

GET

Summary

Search Reorder.

Description

API to fetch Reorder Report.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Reorder Report fetched successfully	ReorderReportDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

ship-list-controller

Ship List Controller

Products inventories/ship-list

GET

Summary

Search pack and ship List.

Description

API to fetch pack and ship list.

Parameters

Name	Located in	Description	Required	Schema
filter	query	filter	No	string
fromDate	query	fromDate	No	dateTime
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string
toDate	query	toDate	No	dateTime

Responses

Code	Description	Schema
200	Pack and ship list has been fetched successfully.	[ ShipmentDocumentDto ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/ship-list/print

POST

Summary

print Shipping label

Description

Api to print shipping label.

Parameters

Name	Located in	Description	Required	Schema
printShippingLabelRequests	body	printShippingLabelRequests	Yes	[ PrintShippingLabelRequest ]

Responses

Code	Description	Schema
200	Selected shipping labels has been printed successfully.	Resource
201	Created
401	Unauthorized
403	Forbidden
404	Shipping label not found. %s %s

Security

Security Schema	Scopes
Authorization	global

Products inventories/ship-list/shiplist-details

POST

Summary

print Shipping label

Description

Api to print shipping label.

Parameters

Name	Located in	Description	Required	Schema
printShippingLabelRequests	body	printShippingLabelRequests	Yes	[ PrintShippingLabelRequest ]

Responses

Code	Description	Schema
200	Selected shipping labels has been printed successfully.	Resource
201	Created
401	Unauthorized
403	Forbidden
404	Shipping label not found. %s %s

Security

Security Schema	Scopes
Authorization	global

Products inventories/ship-list/void

PUT

Summary

void ship list

Description

API to void shiplist after passing documentCodes.

Parameters

Name	Located in	Description	Required	Schema
salesDocumentDtos	body	salesDocumentDtos	Yes	[ SalesDocumentDto ]

Responses

Code	Description
200	Selected shiplists has been voided successfully.
201	Created
400	shiplists can not be voided.
401	Unauthorized
403	Forbidden
404	Order not found. %s

Security

Security Schema	Scopes
Authorization	global

Products inventories/ship-list/{documentCode}/{documentType}

GET

Summary

Get Shipping details by document code and document type

Description

API to fetch Shipping details by document code and document type.

Parameters

Name	Located in	Description	Required	Schema
documentCode	path	documentCode	Yes	string
documentType	path	documentType	Yes	string

Responses

Code	Description	Schema
200	Shipping information fetched successfully.	ShipListDto
401	Unauthorized
403	Forbidden
404	Shipping order not found with code %s , type %s .

Security

Security Schema	Scopes
Authorization	global

POST

Summary

create shipping details by document code and document type

Description

API to create shipping details by document code and document type.

Parameters

Name	Located in	Description	Required	Schema
documentCode	path	documentCode	Yes	string
documentType	path	documentType	Yes	string
shipListRequest	body	shipListRequest	Yes	ShipListRequest

Responses

Code	Description	Schema
200	OK	ShipListResponse
201	Shipping information created successfully.	ShipListResponse
401	Unauthorized
403	Forbidden
404	Shipping order not found with code %s , type %s .

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

update shipping details by document code and document type

Description

API to update shipping details by document code and document type.

Parameters

Name	Located in	Description	Required	Schema
documentCode	path	documentCode	Yes	string
documentType	path	documentType	Yes	string
shipListRequest	body	shipListRequest	Yes	ShipListRequest

Responses

Code	Description	Schema
200	shipping information updated successfully.	ShipListResponse
201	Created
401	Unauthorized
403	Forbidden
404	Shipping order not found with code %s , type %s .

Security

Security Schema	Scopes
Authorization	global

warehouse-controller

Warehouse Controller

Products inventories/warehouses

GET

Summary

Get warehouse list for tenant.

Description

API to fetch warehouse list for tenant.

Responses

Code	Description	Schema
200	Warehouse information fetched successfully.	[ WarehouseResponse ]
401	Unauthorized
403	Forbidden
404	Warehouse not found with id %s

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create Warehouse.

Description

API to create warehouse.

Parameters

Name	Located in	Description	Required	Schema
wareHouseRequest	body	wareHouseRequest	Yes	WareHouseRequest

Responses

Code	Description	Schema
200	OK	WarehouseResponse
201	Warehouse has been created successfully.	WarehouseResponse
400	Warehouse could not be created due to insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/warehouses/assignusers/{id}

POST

Summary

Assign users to warehouse

Description

API to assign users to warehouse

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
userIds	body	userIds	Yes	[ long ]

Responses

Code	Description
200	Users for warehouse assigned successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Warehouse with given id not found.

Security

Security Schema	Scopes
Authorization	global

Products inventories/warehouses/jobworkout

GET

Summary

Get Job Work Out Warehouse tenant.

Description

API to fetch Job Work Out Warehouse tenant.

Responses

Code	Description	Schema
200	Job Work Out Warehouse code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Job Work Out Warehouse not found for Tenant

Security

Security Schema	Scopes
Authorization	global

Products inventories/warehouses/jobworkoutwarehouse

POST

Summary

create job work out warehouse.

Description

API to create job work out warehouse.

Responses

Code	Description
200	OK
201	Created
204	Warehouse has been created successfully.
401	Unauthorized
403	Forbidden
404	Warehouse not created.

Security

Security Schema	Scopes
Authorization	global

Products inventories/warehouses/primary

GET

Summary

Get Primary Warehouse tenant.

Description

API to fetch Primary Warehouse tenant.

Responses

Code	Description	Schema
200	Primary Warehouse code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Primary Warehouse not found for Tenant

Security

Security Schema	Scopes
Authorization	global

Products inventories/warehouses/rejected

GET

Summary

Get Rejected Warehouse tenant.

Description

API to fetch Rejected Warehouse tenant.

Responses

Code	Description	Schema
200	Rejected Warehouse code fetched successfully.	string
401	Unauthorized
403	Forbidden
404	Rejected Warehouse not found for Tenant

Security

Security Schema	Scopes
Authorization	global

Products inventories/warehouses/rejectedwarehouse

POST

Summary

create rejected warehouse.

Description

API to create rejected warehouse.

Responses

Code	Description
200	OK
201	Created
204	Warehouse has been created successfully.
401	Unauthorized
403	Forbidden
404	Warehouse not created.

Security

Security Schema	Scopes
Authorization	global

Get Warehouses

GET

Summary

Search Warehouse.

Description

API to fetch Warehouse.

Parameters

Name	Located in	Description	Required	Schema
filterOnRolesFlg	query	filterOnRolesFlg	No	boolean
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	API to fetch Warehouse.	WarehouseResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/warehouses/shortinfo

GET

Summary

Get warehouse short info by warehouse code.

Description

API to fetch warehouse short info by warehouse code.

Parameters

Name	Located in	Description	Required	Schema
filterOnRolesFlg	query	filterOnRolesFlg	No	boolean

Responses

Code	Description	Schema
200	Warehouse information fetched successfully.	WarehouseResponse
401	Unauthorized
403	Forbidden
404	Warehouse not found with id %s

Security

Security Schema	Scopes
Authorization	global

Products inventories/warehouses/type/{type}

GET

Summary

Get Warehouse by type

Description

API to fetch Warehouse by type.

Parameters

Name	Located in	Description	Required	Schema
type	path	type	Yes	string

Responses

Code	Description	Schema
200	Warehouse by type is fetched successfully.	WarehouseResponse
401	Unauthorized
403	Forbidden
404	Warehouse by type not found.

Security

Security Schema	Scopes
Authorization	global

POST

Summary

create warehouse by type.

Description

API to create warehouse by type.

Parameters

Name	Located in	Description	Required	Schema
type	path	type	Yes	string

Responses

Code	Description
200	OK
201	Created
204	Warehouse has been created successfully.
401	Unauthorized
403	Forbidden
404	Warehouse not created.

Security

Security Schema	Scopes
Authorization	global

Get Inentory waraehouses

Get Warehouse products

GET

Summary

Get all active Warehouse details with product and available quantity.

Description

API to fetch Warehouse details with product and available quantity.

Parameters

Name	Located in	Description	Required	Schema
filterOnRolesFlg	query	filterOnRolesFlg	No	boolean
warehouseCode	query	warehouseCode	No	string

Responses

Code	Description	Schema
200	Warehouse details with available quantity has been fetched successfully.	WHProductResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Get Ware house details with available quantity by product codes.

Description

API to fetch Ware house details with available quantity by product codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Ware house details with available quantity by product codes has been fetched successfully.	WHProductResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/warehouses/warehouse-products-code

POST

Summary

Get Warehouse details with product Codes and available quantity.

Description

API to fetch Warehouse details with product Codes and available quantity.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]
warehouseCode	query	warehouseCode	No	string

Responses

Code	Description	Schema
200	Warehouse details with available quantity has been fetched successfully.	WHProductResponse
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get Advanced Track Based on product code

GET

Summary

Get Warehouse details with product Codes and available quantity.

Description

API to fetch Warehouse details with product Codes and available quantity.

Parameters

Name	Located in	Description	Required	Schema
includeQC	query	includeQC	No	boolean
isCombined	query	isCombined	No	boolean
productCode	query	productCode	Yes	string
warehouseCode	query	warehouseCode	No	string

Responses

Code	Description	Schema
200	Warehouse details with available quantity has been fetched successfully.	WHProductResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products inventories/warehouses/{code}

GET

Summary

Get warehouse details by warehouse code.

Description

API to fetch warehouse details by warehouse code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Warehouse information fetched successfully.	WarehouseResponse
401	Unauthorized
403	Forbidden
404	Warehouse not found with id %s

Security

Security Schema	Scopes
Authorization	global

Products inventories/warehouses/{id}

PUT

Summary

Update Warehouse.

Description

API to update existing Warehouse

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
wareHouseRequest	body	wareHouseRequest	Yes	WareHouseRequest

Responses

Code	Description	Schema
200	Warehouse has been updated successfully.	WarehouseResponse
201	Created
401	Unauthorized
403	Forbidden
404	Warehouse with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete Warehouse by id.

Description

API to delete warehouse details by id.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Warehouse has been deleted successfully.
401	Unauthorized
403	Forbidden
404	Warehouse not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update warehouse status

Description

API to update warehouse status

Parameters

Name	Located in	Description	Required	Schema
active	query	active	No	boolean
id	path	id	Yes	long
primary	query	primary	No	boolean

Responses

Code	Description
200	Active/Primary for warehouse updated successfully.
204	No Content
401	Unauthorized
403	Forbidden
404	Warehouse with given id not found.

Security

Security Schema	Scopes
Authorization	global

product-controller-malaysia

Product Malaysia APIs

Products my

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseMalaysia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequestMalaysia	body	productRequestMalaysia	Yes	ProductRequestMalaysia

Responses

Code	Description	Schema
200	OK	ProductResponseMalaysia
201	Product has been created successfully.	ProductResponseMalaysia
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products my/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products my/all-tariff-service

GET

Summary

Fetch all TARIFF and SERVICE codes information

Description

API to get all TARIFF and SERVICE codes information

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	All TARIFF and SERVICE codes information have been fetched successfully.	TariffAndServiceCode
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products my/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products my/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products my/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products my/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products my/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products my/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequestMalaysia ]

Responses

Code	Description	Schema
200	OK	[ ProductResponseMalaysia ]
201	Products have been imported successfully.	[ ProductResponseMalaysia ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products my/inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products my/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products my/service

GET

Summary

Fetch SERVICE code information

Description

API to get SERVICE code information

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	SERVICE code information have been fetched successfully.	ServiceTypeMalaysiaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products my/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products my/tariff

GET

Summary

Fetch TARIFF code information

Description

API to get TARIFF code information

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	TARIFF code information have been fetched successfully.	TarifCodeMalaysiaDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products my/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequestMalaysia	body	productRequestMalaysia	Yes	ProductRequestMalaysia

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseMalaysia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponseMalaysia
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

product-controller-nl

Product Netherlands APIs

Products nl

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Product has been created successfully.	ProductResponse
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products nl/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/briefbyaccountcode/{accountCode}

GET

Summary

Get product brief information by account code.

Description

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	Product brief information by account code have been fetched successfully.	[ ProductResponse ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/code/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/demo/{tenantId}

POST

Summary

Create demo Products.

Description

API to create demo products.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequest ]

Responses

Code	Description	Schema
200	OK	[ ProductResponse ]
201	Products have been imported successfully.	[ ProductResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/info

POST

Summary

Fetch product details by codes

Description

Fetch product details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ProductInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products nl/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/opening-inventory-acc-codes

GET

Summary

Get Inventory Account Codes of Products with Opening Valuation

Description

API to Get Inventory Account Codes of Products with Opening Valuation

Responses

Code	Description	Schema
200	Inventory Account Codes of Products with Opening Valuation fetched successfully	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nl/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseIndia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

product-controller-nz

v1/products/nz

Products nz

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Product has been created successfully.	ProductResponse
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products nz/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/briefbyaccountcode/{accountCode}

GET

Summary

Get product brief information by account code.

Description

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	Product brief information by account code have been fetched successfully.	[ ProductResponse ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/code/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/demo/{tenantId}

POST

Summary

Create demo Products.

Description

API to create demo products.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequest ]

Responses

Code	Description	Schema
200	OK	[ ProductResponse ]
201	Products have been imported successfully.	[ ProductResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/info

POST

Summary

Fetch product details by codes

Description

Fetch product details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ProductInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products nz/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/opening-inventory-acc-codes

GET

Summary

Get Inventory Account Codes of Products with Opening Valuation

Description

API to Get Inventory Account Codes of Products with Opening Valuation

Responses

Code	Description	Schema
200	Inventory Account Codes of Products with Opening Valuation fetched successfully	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products nz/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseIndia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

product-controller-philippines

Product Philippines APIs

Products ph

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponsePhilippines
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequestPhilippines

Responses

Code	Description	Schema
200	OK	ProductResponsePhilippines
201	Product has been created successfully.	ProductResponsePhilippines
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products ph/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ph/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ph/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ph/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ph/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ph/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ph/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequestPhilippines ]

Responses

Code	Description	Schema
200	OK	[ ProductResponse ]
201	Products have been imported successfully.	[ ProductResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ph/inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products ph/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ph/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products ph/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequestPhilippines

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponsePhilippines
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

price-list-controller

Price List Controller

Products price-list

GET

Summary

GET price lists

Description

API to get all existing price lists

Responses

Code	Description	Schema
200	Price lists have been fetched successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new Price List.

Description

API to create new Price List.

Parameters

Name	Located in	Description	Required	Schema
priceListDto	body	priceListDto	Yes	PriceListDto

Responses

Code	Description	Schema
200	OK	PriceListDto
201	Price List has been created successfully.	PriceListDto
400	Price List creation failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products price-list/active/{id}

PUT

Summary

Update existing UOM active status.

Description

API to update existing UOM active status.

Parameters

Name	Located in	Description	Required	Schema
active	body	active	Yes	boolean
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	PriceListDto
201	UOM active status has been updated successfully.	PriceListDto
400	UOM active status update has been failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products price-list/assign-price-list/{id}

PUT

Summary

Assign price list to contacts.

Description

API to assign price list to contacts.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
request	body	request	Yes	PriceListContactsUpdateRequest

Responses

Code	Description	Schema
200	OK	PriceListDto
201	Contacts assigned to price list successfully.	PriceListDto
400	Assign price list to contacts has been failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products price-list/change/{id}

PUT

Summary

Update existing UOM prices by percentage.

Description

API to update existing UOM prices by percentage.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
request	body	request	Yes	PriceListPercentageUpdateRequest

Responses

Code	Description	Schema
200	OK	PriceListDto
201	UOM prices has been updated successfully by percentage.	PriceListDto
400	UOM prices by percentage update has been failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products price-list/contact-price-lists

POST

Summary

Update contact in price lists.

Description

API to update contact in price lists.

Parameters

Name	Located in	Description	Required	Schema
request	body	request	Yes	ContactUpdatePriceListRequest

Responses

Code	Description
200	OK
201	Contact updated in price lists successfully.
400	Update contact in price lists has been failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products price-list/contact-price-lists/bulk

POST

Summary

Bulk Update contacts in price lists.

Description

API to bulk update contact in price lists.

Parameters

Name	Located in	Description	Required	Schema
request	body	request	Yes	[ ContactUpdatePriceListRequest ]

Responses

Code	Description	Schema
200	OK	[ BulkApiResponse ]
201	Bulk Contacts updated in price lists successfully.	[ BulkApiResponse ]
400	Bulk Update contacts in price lists has been failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

GET Document Price list

POST

Summary

Get prices for products.

Description

API to get prices for products.

Parameters

Name	Located in	Description	Required	Schema
request	body	request	Yes	PriceListPricingRequest

Responses

Code	Description	Schema
200	OK	[ object ]
201	Prices for products fetched successfully.	[ object ]
400	Prices for products failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products price-list/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
request	body	request	Yes	[ PriceListDto ]

Responses

Code	Description	Schema
200	OK	[ BulkApiResponse ]
201	Products have been imported successfully.	[ BulkApiResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products price-list/prices

POST

Summary

Get prices by uom.

Description

API to get prices by uom.

Responses

Code	Description	Schema
200	OK	object
201	Prices by uom fetched successfully.	object
400	Prices by uom failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products price-list/purchase-sales-price-list/{contactCode}

GET

Summary

Get purchase and sales price list by contact code.

Description

API to get purchase and sales price list by contact code.

Parameters

Name	Located in	Description	Required	Schema
contactCode	path	contactCode	Yes	string

Responses

Code	Description	Schema
200	Purchase and sales price list by contact code has been fetched successfully.	PurchaseSalesPriceListDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get All Products price-list

GET

Summary

Search Price lists.

Description

API to search existing price lists.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Price lists have been fetched successfully.	Page«PriceListDto»
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products price-list/{id}

GET

Summary

GET price list by id

Description

API to get price list by id

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Price list has been fetched successfully.	PriceListDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

PUT

Summary

Update existing price list.

Description

API to update existing price list.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
priceListDto	body	priceListDto	Yes	PriceListDto

Responses

Code	Description	Schema
200	Price list has been updated successfully.	PriceListDto
201	Created
401	Unauthorized
403	Forbidden
404	Price list with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete price list.

Description

API to delete existing price list.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Price list has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Price list has not been found to delete

Security

Security Schema	Scopes
Authorization	global

product-uom-contact-mapping-controller

Product Uom Contact Mapping Controller

Products product-uom-contact/mapping

GET

Summary

Retrieve product uom and contact mapping

Description

Retrieve product uom and contact mapping

Parameters

Name	Located in	Description	Required	Schema
contactCode	query	contactCode	No	string
productCode	query	productCode	Yes	string

Responses

Code	Description	Schema
200	Fetch product uom and contact mapping	UOMDto
400	Could not get mapping
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products product-uom-contact/mapping/{documentType}/{documentCode}

GET

Summary

Save product uom and contact mapping

Description

Save product uom and contact mapping

Parameters

Name	Located in	Description	Required	Schema
documentCode	path	documentCode	Yes	string
documentType	path	documentType	Yes	string

Responses

Code	Description
200	Fetch product uom and contact mapping
400	Could not get mapping
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

qc-document-details-controller

QC Transaction APIs

Add Product QC transaction

POST

Summary

Create new qc transaction.

Description

API to create new qc transaction.

Parameters

Name	Located in	Description	Required	Schema
qcTransactionDetailsDto	body	qcTransactionDetailsDto	Yes	QCDocumentDetailsRequestDto

Responses

Code	Description	Schema
200	OK	QCDocumentDetailsResponseDto
201	QC transaction has been created successfully.	QCDocumentDetailsResponseDto
400	QC transaction creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products qctransaction/qcdetailsbyid/{documentId}

GET

Summary

Get QC document details by id

Description

API to get QC document details by id for a tenant

Parameters

Name	Located in	Description	Required	Schema
documentId	path	documentId	Yes	long

Responses

Code	Description	Schema
200	Fetched QC document details by id successfully.	StockTransferDto
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products qctransaction/qcdocuments

POST

Summary

Create new qc document.

Description

API to create new qc document.

Parameters

Name	Located in	Description	Required	Schema
qcDocumentRequestDtos	body	qcDocumentRequestDtos	Yes	[ QCDocumentRequestDto ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	QC document has been created successfully.	[ object ]
400	QC document creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products qctransaction/qcdocumentsbyproductcodes

POST

Summary

Get qc documents by product codes.

Description

API to get qc documents by product codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ object ]
201	QC document has been fetched successfully.	[ object ]
400	Unable to fetch QC documents.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get QC trandaction Paged

GET

Summary

Get qc transactions.

Description

API to get qc transactions.

Parameters

Name	Located in	Description	Required	Schema
fromDate	query	fromDate	No	dateTime
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string
toDate	query	toDate	No	dateTime

Responses

Code	Description	Schema
200	OK	QCDocumentResponseDto
201	QC transaction has been fetched successfully.	QCDocumentResponseDto
400	Unable to fetch QC transactions.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

product-controller-saudi-arabia

Product Saudi Arabia APIs

Products sa

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseSaudiArabia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequestSaudiArabia

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Product has been created successfully.	ProductResponse
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products sa/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products sa/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products sa/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products sa/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products sa/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products sa/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products sa/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequestSaudiArabia ]

Responses

Code	Description	Schema
200	OK	[ ProductResponse ]
201	Products have been imported successfully.	[ ProductResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products sa/inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products sa/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products sa/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products sa/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequestSaudiArabia

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseSaudiArabia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

stock-issue-controller

Stock Issue APIs

Products stockissue

GET

Summary

Search stock issue

Description

API to search stock issue.

Parameters

Name	Located in	Description	Required	Schema
customField	query	customField	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Stock issue have been fetched successfully.	StockIssueResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create stock request

Description

API to create stock request.

Parameters

Name	Located in	Description	Required	Schema
stockIssueRequest	body	stockIssueRequest	Yes	StockIssueRequest

Responses

Code	Description	Schema
200	OK	StockIssueResponse
201	Stock Request has been created	StockIssueResponse
400	Unable to create stock issue
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products stockissue/{code}

GET

Summary

Get stock issue by id.

Description

API to fetch stock issue details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Stock issue information has been fetched successfully.	AbstractStockIssueResponse
401	Unauthorized
403	Forbidden
404	Stock issue not found.

Security

Security Schema	Scopes
Authorization	global

stock-request-controller

Stock Request APIs

Products stockrequest

GET

Summary

Search stock requests

Description

API to search stock requests.

Parameters

Name	Located in	Description	Required	Schema
customField	query	customField	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Stock requests have been fetched successfully.	StockRequestResponse
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create stock request

Description

API to create stock request.

Parameters

Name	Located in	Description	Required	Schema
stockRequestRequest	body	stockRequestRequest	Yes	StockRequestRequest

Responses

Code	Description	Schema
200	OK	StockRequestResponse
201	Stock Request has been created	StockRequestResponse
400	Unable to create stock request
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products stockrequest/approvestatus/{id}

PUT

Summary

Update approve status of stock request

Description

API to update approve status of stock request.

Parameters

Name	Located in	Description	Required	Schema
approveRequest	body	approveRequest	Yes	StockRequestUpdateApproveRequest
id	path	id	Yes	long

Responses

Code	Description	Schema
200	Stock Request has been updated	StockRequestResponse
201	Created
400	Unable to update stock request
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products stockrequest/linked-docs/product-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details fetched successfully	string
201	Created
401	Unauthorized
403	Forbidden
404	Error in fetching product details

Security

Security Schema	Scopes
Authorization	global

Products stockrequest/{code}

GET

Summary

Get stock request by id.

Description

API to fetch stock request details by it's code.

Parameters

Name	Located in	Description	Required	Schema
code	path	code	Yes	string

Responses

Code	Description	Schema
200	Stock request information has been fetched successfully.	AbstractStockRequestResponse
401	Unauthorized
403	Forbidden
404	Stock request not found.

Security

Security Schema	Scopes
Authorization	global

Products stockrequest/{id}

PUT

Summary

Update stock request

Description

API to update stock request

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
stockRequestRequest	body	stockRequestRequest	Yes	StockRequestRequest

Responses

Code	Description	Schema
200	Stock request updated succesfully	AbstractStockRequestResponse
201	Created
400	Stock request draft status cannot be changed after saving
401	Unauthorized
403	Forbidden
404	Stock request with given id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete Stock Request by ID

Description

API to delete stock request

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description
200	OK
204	Stock request has been deleted
401	Unauthorized
403	Forbidden
404	Stock request to delete not found

Security

Security Schema	Scopes
Authorization	global

product-controller-uk

v1/products/uk

Products uk

GET

Summary

Search products.

Description

API to search existing products.

Parameters

Name	Located in	Description	Required	Schema
barcode	query	barcode	No	string
contactCode	query	contactCode	No	string
customfield	query	customfield	No	string
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	Products have been fetched successfully.	ProductResponseIndia
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new product.

Description

API to create new product.

Parameters

Name	Located in	Description	Required	Schema
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	OK	ProductResponse
201	Product has been created successfully.	ProductResponse
400	Product creation failed because of insufficient data.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete product.

Description

API to delete existing product.

Parameters

Name	Located in	Description	Required	Schema
productIds	body	productIds	Yes	[ long ]

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	Product has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	Product has been created successfully.

Security

Security Schema	Scopes
Authorization	global

Products uk/activate

PUT

Summary

Change status of multiple products.

Description

API to change status of multiple products.

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]
status	query	status	Yes	boolean

Responses

Code	Description
200	Product status has been changed successfully.
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/barcode-generate

GET

Summary

Get product details by barcode.

Description

API to get product details for given barcode valie.

Parameters

Name	Located in	Description	Required	Schema
search	query	search	No	string

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/barcodes

POST

Summary

Get product details for barcodes.

Description

API to get product details for given barcodes.

Parameters

Name	Located in	Description	Required	Schema
barcodes	body	barcodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/brief

GET

Summary

Get product brief information

Description

API to get brief information of all the products

Responses

Code	Description	Schema
200	Product brief information have been fetched successfully.	[ ProductShortInfo ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/briefbyaccountcode/{accountCode}

GET

Summary

Get product brief information by account code.

Description

Parameters

Name	Located in	Description	Required	Schema
accountCode	path	accountCode	Yes	string

Responses

Code	Description	Schema
200	Product brief information by account code have been fetched successfully.	[ ProductResponse ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/code/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/custom-fields

GET

Summary

Get custom field is used or not

Description

API to Get custom field is used or not

Parameters

Name	Located in	Description	Required	Schema
customCode	query	customCode	Yes	string

Responses

Code	Description	Schema
200	Custom fields status fetched successfully	boolean
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/demo/{tenantId}

POST

Summary

Create demo Products.

Description

API to create demo products.

Parameters

Name	Located in	Description	Required	Schema
country	query	country	No	string
tenantId	path	tenantId	Yes	long

Responses

Code	Description
200	OK
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/details

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
productCodes	body	productCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/doc-seq-codes

POST

Summary

Get product details.

Description

API to get product details for given products codes.

Parameters

Name	Located in	Description	Required	Schema
documentSequenceCodes	body	documentSequenceCodes	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	ProductDetails
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/import

POST

Summary

Import products

Description

API to import products.

Parameters

Name	Located in	Description	Required	Schema
productRequests	body	productRequests	Yes	[ ProductRequest ]

Responses

Code	Description	Schema
200	OK	[ ProductResponse ]
201	Products have been imported successfully.	[ ProductResponse ]
400	Product import failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/info

POST

Summary

Fetch product details by codes

Description

Fetch product details by codes

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	OK	[ ProductInformation ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/inventory

PUT

Summary

Update Inventory

Description

API to update inventory Opening Balance and Opening valuation in bulk.

Parameters

Name	Located in	Description	Required	Schema
inventoryRequests	body	inventoryRequests	Yes	[ InventoryRequest ]

Responses

Code	Description	Schema
200	Inventory has been updated successfully.	[ InventoryResponse ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found
500	Inventory update fails.

Security

Security Schema	Scopes
Authorization	global

Products uk/names

POST

Summary

Get product details for names.

Description

API to get product details for given names.

Parameters

Name	Located in	Description	Required	Schema
names	body	names	Yes	[ string ]

Responses

Code	Description	Schema
200	Product details have been fetched successfully.	[ object ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/opening-inventory-acc-codes

GET

Summary

Get Inventory Account Codes of Products with Opening Valuation

Description

API to Get Inventory Account Codes of Products with Opening Valuation

Responses

Code	Description	Schema
200	Inventory Account Codes of Products with Opening Valuation fetched successfully	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/summary

GET

Summary

Product summary.

Description

API for products summary.

Responses

Code	Description	Schema
200	Products summary has been fetched successfully.	ProductSummaryResponse
400	Failed to fetch product summary.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uk/{id}

PUT

Summary

Update existing product.

Description

API to update existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
productRequest	body	productRequest	Yes	ProductRequest

Responses

Code	Description	Schema
200	Product has been updated successfully.	ProductResponseIndia
201	Created
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

PATCH

Summary

Update product attributes.

Description

API to update attributes of existing product.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
product	body	product	Yes	object

Responses

Code	Description	Schema
200	Product attributes has been updated successfully.	ProductResponse
204	No Content
401	Unauthorized
403	Forbidden
404	Product with id not found.

Security

Security Schema	Scopes
Authorization	global

uom-controller

UOM Controller

Products uom

GET

Summary

GET UOMs

Description

API to get all existing UOMs

Responses

Code	Description	Schema
200	UOMs have been fetched successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new UOM.

Description

API to create new UOM.

Parameters

Name	Located in	Description	Required	Schema
uomDto	body	uomDto	Yes	UOMDto

Responses

Code	Description	Schema
200	OK	UOMDto
201	UOM has been created successfully.	UOMDto
400	UOM creation failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uom/active

GET

Summary

GET UOMs

Description

API to get all existing UOMs

Responses

Code	Description	Schema
200	UOMs have been fetched successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uom/productCodes

POST

Summary

UOM Details

Description

API to get UOM details

Parameters

Name	Located in	Description	Required	Schema
codes	body	codes	Yes	[ string ]

Responses

Code	Description	Schema
200	UOM details fetched successfully	object
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get Product UOM paged

GET

Summary

Search UOMs.

Description

API to search existing UOMs.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
query	query	query	No	string
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	UOMs have been fetched successfully.	Page«UOMDto»
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uom/uom-codes

POST

Summary

UOM Details

Description

API to get UOM details

Parameters

Name	Located in	Description	Required	Schema
ids	body	ids	Yes	[ long ]

Responses

Code	Description	Schema
200	UOM details fetched successfully	[ UOMDto ]
201	Created
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uom/{id}

PUT

Summary

Update existing UOM.

Description

API to update existing UOM.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
uomDto	body	uomDto	Yes	UOMDto

Responses

Code	Description	Schema
200	UOM has been updated successfully.	UOMDto
201	Created
401	Unauthorized
403	Forbidden
404	UOM with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete UOM.

Description

API to delete existing UOM.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	UOM has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	UOM has not been found to delete

Security

Security Schema	Scopes
Authorization	global

uom-schema-controller

UOM Schema Controller

Products uom-schema

GET

Summary

GET UOM Schemas

Description

API to get all existing UOM Schemas

Responses

Code	Description	Schema
200	UOM Schemas have been fetched successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

POST

Summary

Create new UOM Schema.

Description

API to create new UOM Schema.

Parameters

Name	Located in	Description	Required	Schema
uomSchemaRequestDto	body	uomSchemaRequestDto	Yes	UOMSchemaRequestDto

Responses

Code	Description	Schema
200	OK	UOMSchemaDto
201	UOM Schema has been created successfully.	UOMSchemaDto
400	UOM Schema creation failed.
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uom-schema/active

GET

Summary

GET UOM Schemas

Description

API to get all existing UOM Schemas

Responses

Code	Description	Schema
200	UOMs have been fetched successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get Active UOM Schema

GET

Summary

GET UOM Schemas by base UOM

Description

API to get all existing UOM Schemas by base UOM

Parameters

Name	Located in	Description	Required	Schema
search	query	search	Yes	long

Responses

Code	Description	Schema
200	UOM Schemas by base UOM have been fetched successfully.	[ object ]
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Get UOM Schema

GET

Summary

Search UOM Schemas.

Description

API to search existing UOM Schemas.

Parameters

Name	Located in	Description	Required	Schema
limit	query	limit	No	integer
page	query	page	No	integer
search	query	search	No	string
sort	query	sort	No	string
sortDir	query	sortDir	No	string

Responses

Code	Description	Schema
200	UOMs have been fetched successfully.	Page«UOMSchemaDto»
401	Unauthorized
403	Forbidden
404	Not Found

Security

Security Schema	Scopes
Authorization	global

Products uom-schema/{id}

PUT

Summary

Update existing UOM Schema.

Description

API to update existing UOM Schema.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long
uomSchemaRequestDto	body	uomSchemaRequestDto	Yes	UOMSchemaRequestDto

Responses

Code	Description	Schema
200	UOM Schema has been updated successfully.	UOMSchemaDto
201	Created
401	Unauthorized
403	Forbidden
404	UOM Schema with id not found.

Security

Security Schema	Scopes
Authorization	global

DELETE

Summary

Delete UOM Schema.

Description

API to delete existing UOM Schema.

Parameters

Name	Located in	Description	Required	Schema
id	path	id	Yes	long

Responses

Code	Description	Schema
200	OK	ResponseEntity
204	UOM Schema has been deleted successfully.	ResponseEntity
401	Unauthorized
403	Forbidden
404	UOM Schema has not been found to delete

Security

Security Schema	Scopes
Authorization	global

Models

AbstractStockIssueResponse

Name	Type	Description	Required
code	string		No
customField	[ CustomFieldItem ]	List of custom fields	No
destWarehouseCode	string		No
destWarehouseName	string		No
documentSequenceCode	string	Stock Issue Document Sequence Code Example: `"0000001"`	No
formattedTransferDate	dateTime		No
id	long	Stock Issue id Example: `1`	No
memo	string	Memo Example: `"Note this"`	No
notes	string		No
sequenceFormat	string	Sequence Format Id Example: `1`	No
srcWarehouseCode	string		No
srcWarehouseName	string		No
stockIssueCode	string	Stock Issue code Example: `"STKIS001"`	No
stockIssueDate	string	Stock Issue date Example: `"25-10-2019"`	Yes
stockIssueItems	[ StockIssueItemDetails ]		No
stockRequestCode	string	Stock Request code Example: `"STKRQ001"`	No
stockRequestItems	[ StockRequestItemDetails ]	Stock Request item details	No
stockTransferCode	string	Stock Transfer code Example: `"STKIS001"`	No
transferDate	dateTime		No
transferDateString	string		No

AbstractStockRequestResponse

Name	Type	Description	Required
approveDate	string	Stock Request Approve date Example: `"25-10-2019"`	Yes
approveStatus	string	Approve Status Example: `"PENDING"`	No
approvedBy	long	Stock Request approved by Example: `1`	No
customField	[ CustomFieldItem ]	List of custom fields	No
documentSequenceCode	string	Stock Request Document Sequence Code Example: `"0000001"`	No
dstWarehouseCode	string	Destination Warehouse Code Example: `"WH-0000001"`	No
id	long	Stock Request id Example: `1`	No
linkedDocuments	[ DocumentInfo ]	Linked document information.	No
linkedStockIssues	[ StockIssueResponse ]		No
memo	string	Memo Example: `"Note this"`	No
sequenceFormat	string	Sequence Format Id Example: `1`	No
stockRequestCode	string	Stock Request code Example: `"STKRQ001"`	No
stockRequestDate	string	Stock Request date Example: `"25-10-2019"`	Yes
stockRequestItems	[ StockRequestItemDetails ]	Stock Request item details	No

AdditionalChargeRequest

Name	Type	Description	Required
applyTo	string	Module for which charges are applicable Enum: `"BUY"`, `"SELL"`, `"BOTH"` Example: `"SELL"`	Yes
apportionFlag	boolean	Apportion this amount or independent charge Example: `true`	No
apportionValue	string	Apportion method Enum: `"APPORTION_MANUAL"`, `"APPORTION_ON_QTY"`, `"APPORTION_ON_VALUE"` Example: `"APPORTION_ON_QTY"`	Yes
chargeApplicableOn	string	Enum: `"TOTAL"`, `"SUBTOTAL"` Example: `"TOTAL"`	Yes
chargeValue	double	Charge value for additional charge Example: `200.33`	No
description	string	Additional charge description Example: `"Description"`	No
expenseAccountCode	string	Expense account code Example: `"A-0013"`	Yes
incomeAccountCode	string	Income account code Example: `"A-0012"`	Yes
indiaProperties	object	Indian Compliance specific properties Example: `[{"HSN":"0101","UOC":"1111"}]`	No
isDiscount	boolean	Check to identify if row is created for discount Example: `true`	No
isPercent	boolean	Is percentage enable? Example: `false`	No
isTaxable	boolean	Is the charge taxable? Example: `false`	No
name	string	Additional Charge Name Example: `"Apple"`	Yes
offeringType	string	Offering type Enum: `"GOODS"`, `"SERVICES"` Example: `"GOODS"`	No
percentageValue	double	Percentage applicable Example: `123.33`	Yes
purchaseTaxCode	string	Purchase tax code Example: `"T-001"`	No
salesTaxCode	string	Sales tax code Example: `"T-002"`	No

AdditionalChargeResponse

Name	Type	Description	Required
active	boolean	Additional Charge status Example: `true`	No
applyTo	string	Module for which charges are applicable Enum: `"BUY"`, `"SELL"`, `"BOTH"` Example: `"SELL"`	Yes
apportionFlag	boolean	Apportion this amount or independent charge Example: `true`	No
apportionValue	string	Apportion method Enum: `"APPORTION_MANUAL"`, `"APPORTION_ON_QTY"`, `"APPORTION_ON_VALUE"` Example: `"APPORTION_ON_QTY"`	Yes
chargeApplicableOn	string	Enum: `"TOTAL"`, `"SUBTOTAL"` Example: `"TOTAL"`	Yes
chargeValue	double	Charge value for additional charge Example: `200.33`	No
description	string	Additional charge description Example: `"Description"`	No
expenseAccountCode	string	Expense account code Example: `"A-0013"`	Yes
id	long	Additional Charge ID Example: `1234`	No
incomeAccountCode	string	Income account code Example: `"A-0012"`	Yes
indiaProperties	object	Indian Compliance specific properties Example: `[{"HSN":"0101","UOC":"1111"}]`	No
isDiscount	boolean	Check to identify if row is created for discount Example: `true`	No
isPercent	boolean	Is percentage enable? Example: `false`	No
isTaxable	boolean	Is the charge taxable? Example: `false`	No
name	string	Additional Charge Name Example: `"Apple"`	Yes
offeringType	string	Offering type Enum: `"GOODS"`, `"SERVICES"` Example: `"GOODS"`	No
percentageValue	double	Percentage applicable Example: `123.33`	Yes
purchaseTaxCode	string	Purchase tax code Example: `"T-001"`	No
salesTaxCode	string	Sales tax code Example: `"T-002"`	No

AdditionalCharges

Name	Type	Required
additionalChargeAmount	number	No
additionalChargeTaxAmount	number	No
additionalChargesDetails	[ AdditionalChargesDetails ]	No
globalDiscount	GlobalDiscountDetails	No
globalDiscounts	[ GlobalDiscountDetails ]	No

AdditionalChargesDetails

Name	Type	Description	Required
additionalCharge	string		No
additionalChargeAccountCode	string		No
addtionalChargeTax	string		No
addtionalChargeTaxCode	string		No
apportionFlag	boolean		No
apportionValue	string	Enum: `"APPORTION_MANUAL"`, `"APPORTION_ON_QTY"`, `"APPORTION_ON_VALUE"`	No
cgst	number		No
chargeAmount	number		No
igst	number		No
isPercent	boolean		No
isPreCharge	boolean		No
percent	number		No
sgst	number		No
taxAmount	number		No

Address

Name	Type	Description	Required
address1	string	Address line 1 Example: `"218, Robinson Road"`	No
address2	string	Address line 2 Example: `"Downtown"`	No
city	string	City Example: `"C001"`	No
contactName	string	contact name for address Example: `"John Smith"`	No
country	string	Country Example: `"C001"`	No
destinationOfSupply	string	state in India Example: `"Maharashtra"`	No
placeOfSupply	string	state in India Example: `"Punjab"`	No
postalCode	string	Postal Code Example: `123456`	No
preferred	boolean	Is this a default address? Example: `true`	No
state	string	State Example: `"CS001"`	No

AdvancedTrackedProductDTO

Name	Type	Description	Required
advancedTrackedDetails	[ AdvancedTrackingMetaDto ]		No
advancedTracking	string	Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
barcode	string		No
description	string		No
documentSequenceCode	string		No
id	long		No
masterProductCode	string		No
name	string		No
pid	string		No
type	string	Enum: `"TRACKED"`, `"NONTRACKED"`, `"BILL_OF_MATERIALS"`	No

AdvancedTrackingBOMDto

Name	Type	Description	Required
costPerUnit	number		No
expiryDate	dateTime	Expiry date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: `"01-01-2020"`	No
manufacturingDate	dateTime	Manufacturing date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: `"01-01-2020"`	No
qtyToFulfil	double	Batch qty to fulfill Example: `1`	No
remainingQuantity	number		No
serialBatchNumber	string	Batch or serial number to be fulfilled Example: `"Batch-001"`	No

AdvancedTrackingCountBySerialBatchDto

Name	Type	Description	Required
numberOfSerialBatch	long	Count of unfulfilled and active serial/batch Example: `4`	Yes
totalQtyAvailable	number	Qty available in unfulfilled and active serial/batch Example: `37.5`	Yes
unassignedOpeningQuantity	number	Qty still unassigned out of the opening valuation Example: `2`	No

AdvancedTrackingData

Name	Type	Description	Required
batchSize	double	Batch qty Example: `1`	No
binCode	string	bin code Example: `"BIN-00001"`	Yes
binName	string	bin name Example: `"BIN-00001"`	No
qtyToFulfil	double	Batch qty to fulfill Example: `1`	No
rackCode	string	Rack code Example: `"RACK-00001"`	Yes
rackName	string	Rack name Example: `"RACK-00001"`	No
rowCode	string	Row code Example: `"ROW-00001"`	Yes
rowName	string	Row Nane Example: `"ROW-00001"`	No
serialBatchNumber	string	Batch or serial number to be fulfilled Example: `"Batch-001"`	No
warehouseCode	string	Warehouse of selected Batch/Serial Example: `"WH-0000001"`	No
warehouseName	string	Warehouse Name Example: `"Warehouse name"`	No

AdvancedTrackingFulfilledByDoc

Name	Type	Description	Required
qtyFulfilled	double		No
transactionRefCode	string		No

AdvancedTrackingFulfilmentDto

Name	Type	Description	Required
binCode	string	bin code Example: `"BIN-00001"`	Yes
binName	string	Bin name Example: `"Bin1"`	No
qtyToFulfil	double	Batch qty to fulfill Example: `1`	No
rackCode	string	Rack code Example: `"RACK-00001"`	Yes
rackName	string	Rack name Example: `"Rack1"`	No
rowCode	string	Row code Example: `"ROW-00001"`	Yes
rowName	string	Row name Example: `"Row1"`	No
serialBatchNumber	string	Batch or serial number to be fulfilled Example: `"Batch-001"`	No
warehouseCode	string	Warehouse of selected Batch/Serial Example: `"WH-0000001"`	No
warehouseName	string	Warehouse name Example: `"Warehouse-1"`	No

AdvancedTrackingInventoryTxn

Name	Type	Required
active	boolean	No
advancedTrackingMeta	AdvancedTrackingMeta	No
createdAt	dateTime	No
createdBy	long	No
id	long	No
inventoryTransaction	InventoryTransaction	No
key	AdvancedTrackingInventoryTxnKey	No
updatedAt	dateTime	No
updatedBy	long	No

AdvancedTrackingInventoryTxnKey

Name	Type	Description	Required
advancedTrackingMetaPk	long		No
inventoryTxnPk	long		No

AdvancedTrackingMeta

Name	Type	Required
acquiredCost	number	No
active	boolean	No
advancedTrackingInventoryTxns	[ AdvancedTrackingInventoryTxn ]	No
advancedTrackingReturned	AdvancedTrackingReturned	No
batchCreationDate	dateTime	No
batchSize	double	No
batchSizeFulfilled	double	No
binCode	string	No
createdAt	dateTime	No
createdBy	long	No
expiryDate	dateTime	No
fulfillmentByDoc	[ AdvancedTrackingFulfilledByDoc ]	No
id	long	No
inventory	Inventory	No
manufacturingDate	dateTime	No
productVariantCode	string	No
rackCode	string	No
reservedQuantity	double	No
reservedQuantityFulfilled	double	No
rowCode	string	No
sequence	long	No
serialBatchNumber	string	No
subSequence	long	No
tenantId	long	No
updatedAt	dateTime	No
updatedBy	long	No
warehouseCode	string	No

AdvancedTrackingMetaDto

Name	Type	Description	Required
acquiredCost	number	Acquired cost of the entire serial or batch Example: `1`	No
advancedTrackingReturned	AdvancedTrackingReturned		No
batchSize	double	Serial Number or Batch size Example: `1`	Yes
batchSizeAvailableForReturn	double	How much of the batch or serial is fulfilled Example: `1`	Yes
batchSizeFulfilled	double	How much of the batch or serial is fulfilled Example: `1`	Yes
batchSizeReturned	double	How much of the batch or serial is returned Example: `1`	Yes
batchSizeReturnedPurchase	double	How much of the batch or serial is returned Example: `1`	Yes
binCode	string	bin code Example: `"BIN-00001"`	Yes
binName	string	bin Name Example: `"Bin 1"`	Yes
expiryDate	dateTime	Expiry date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: `"01-01-2020"`	No
id	long		No
manufacturingDate	dateTime	Manufacturing date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: `"01-01-2020"`	No
productVariantCode	string	Product code Example: `"P-001"`	Yes
rackCode	string	Rack code Example: `"RACK-00001"`	Yes
rackName	string	Rack Name Example: `"Rack 1"`	Yes
reservedQuantity	double	Reserved Serial Number or Batch size Example: `1`	No
reservedQuantityFulfilled	double	Fulfilled reserved serial number or batch size Example: `1`	Yes
rowCode	string	Row code Example: `"ROW-00001"`	Yes
rowName	string	Row Name Example: `"Row 1"`	Yes
sequence	long	Sequence number Example: `1`	No
serialBatchNumber	string	Serial Number or Batch Number Example: `"BATCH-001"`	Yes
subSequence	long	Subsequence number Example: `1`	No
warehouseCode	string	Primary Warehouse Example: `"WH-0000001"`	No
warehouseName	string	Primary Warehouse Example: `"warehouse name"`	No

AdvancedTrackingReturned

Name	Type	Required
batchSizeReturned	double	No
batchSizeReturnedPurchase	double	No
returnsByDoc	[ AdvancedTrackingReturnedByDoc ]	No

AdvancedTrackingReturnedByDoc

Name	Type	Description	Required
documentCode	string		No
qtyReturned	double		No
returnType	string	Enum: `"SALES_RETURN"`, `"PURCHASE_RETURN"`	No
transactionRefCode	string		No

AdvancedTrackingStockTransferDto

Name	Type	Description	Required
destSerialBatchNumber	string	Destination Batch or serial number Example: `"Batch-002"`	No
expiryDate	dateTime	Expiry date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: `"01-01-2020"`	No
manufacturingDate	dateTime	Manufacturing date. Date Format is dd-mm-yyyy. Applicable when AdvancedTrackingType is Batch Example: `"01-01-2020"`	No
qtyToTransfer	number	Batch qty to Transfer Example: `1`	No
sourceSerialBatchNumber	string	Source Batch or serial number Example: `"Batch-001"`	No

AssignBatchSerialRequest

Name	Type	Description	Required
advancedTrackingMetaData	[ AdvancedTrackingMetaDto ]		No
productVariantCode	string	Product ID Example: `"P-000001"`	No

AttributeDetails

Name	Type	Description	Required
id	long	Attribute ID Example: `"Id"`	No
name	string	Attribute Name Example: `"Colour"`	No
values	[ string ]	Attribute values	No

AttributeRequest

Name	Type	Description	Required
name	string	attribute of product Example: `"colour"`	No

AttributeResponse

Name	Type	Required
active	boolean	No
id	long	No
isSystemGenerated	boolean	No
name	string	No
tenantId	long	No

BOMAssemblyDetailsResponse

Name	Type	Description	Required
allowQuantityToBuild	integer	No Of product quantity to allow to build Example: `10.5`	No
bomProductsConfiguration	[ BOMAssemblyItemDetailsDto ]	Bom Products information	No
costPerUnit	number	Cost Per Unit Example: `10.5`	No
description	string	Product Description Example: `"Test Product"`	Yes
id	long	id of item in bom Example: `1234`	No
name	string	Product Name Example: `"Apple"`	Yes
pid	string	Product Id Example: `"P-0000021"`	Yes
productCode	string	Product Code Example: `"P-0000021"`	Yes
totalAvailableQuantity	double	Available Quantity of product in bom Example: `10.5`	No

BOMAssemblyItemDetailsDto

Name	Type	Description	Required
advancedTracking	string	NONE, BATCH, SERIAL Enum: `"NONE"`, `"BATCH"`, `"SERIAL"` Example: `"BATCH"`	No
availableQuantity	number	Available Quantity Example: `100`	No
costPerUnit	number	Cost Per Unit Example: `10.5`	No
itemId	long	id of item in bom Example: `1234`	No
itemName	string	Product Name Example: `"Apple"`	Yes
pid	string	Product Id Example: `"P-0000021"`	Yes
productCode	string	Product Code Example: `"P-0000021"`	Yes
purchasePrice	number	Product Purchase Price Example: `10.5`	No
quantity	number	Quantity of product in bom Example: `10.5`	No
type	string	Enum: `"TRACKED"`, `"NONTRACKED"`, `"BILL_OF_MATERIALS"`	No
uomId	long	UOM id	No
uomName	string	UOM name	No

BarcodeDetails

Name	Type	Description	Required
barcodeField	string		No
hideBarcodeLabel	boolean		No

BarcodeInfoDto

Name	Type	Required
barcode	string	No
isBatchSerialProduct	boolean	No
productCode	string	No

BatchDetails

Name	Type	Required
batch	string	No
expiryDate	dateTime	No
manufacturingDate	dateTime	No
quantity	number	No

BomAdditionalCostDto

Name	Type	Description	Required
bomMetaDetailsId	long	id of bomMetaDetailsId Example: `1234`	No
bomMetaName	string	BOM Meta Name Example: `"DEFAULT"`	No
label	string	Name of manufacturing service Example: `"Labour charges"`	No
price	number	Quantity of product in bom Example: `10.5`	No

BomAssemblyDetailsDto

Name	Type	Description	Required
actualQuantityUsed	number	Actual Quantity Used Example: `1`	Yes
advancedTracking	string	Tracking type of product Example: `"NONE"`	No
costPerUnit	number	Cost Per Unit Example: `100`	Yes
documentCode	string	Document Code Example: `"BOM-0000001"`	Yes
documentSequenceCode	string	Document Code Example: `"BOM-0000001"`	Yes
id	long	Id Example: `1234`	Yes
isQuickCommit	boolean	Auto Commit Flag Example: `false`	No
pid	string	Product Id Example: `"P00001"`	Yes
produceProductType	string	Produce Product type Enum: `"NONE"`, `"SCRAP"`, `"COPRODUCT"` Example: `"SCRAP"`	Yes
productCode	string	Product code Example: `"P00001"`	Yes
productId	long	Product Id Example: `1`	Yes
productName	string	Product Name Example: `"Hard Disk"`	Yes
quantityRequired	number	Quantity Required Example: `1`	Yes
rawMaterial	boolean	Raw Material/Additional Cost Example: `true`	No
totalCost	number	Total Cost Example: `100`	No
totalQuantity	number	Quantity Total Example: `1`	Yes
transactionRefCode	string	Transaction Ref code Example: `"BI-0000001"`	Yes
warehouseInventoryData	[ WarehouseInventoryData ]	Bom Assembly Details	Yes

BomAssemblyRequest

Name	Type	Description	Required
advancedTracking	string	Tracking type of product Example: `"NONE"`	No
assemblyDate	string	Assembly Date Example: `"01-07-2021"`	Yes
bomAssemblyDetails	[ BomAssemblyDetailsDto ]	Bom Assembly Details	Yes
bomMetaCode	string	BOM Meta Code Example: `"0000001"`	No
buildQuantityMax	number	Max Product Quantity that can be build Example: `10`	Yes
buildQuantityReq	number	Required Quantity to build Example: `5`	Yes
costPerUnit	number	Cost per Unit Example: `120`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
documentSequenceCode	string	0000001	No
memo	string	Memo Example: `"Computer Memo"`	Yes
pid	string	pid Example: `"P-0000001"`	Yes
productCode	string	Product Code Example: `"P-0000001"`	Yes
productId	long	Product Id Example: `1234`	Yes
productName	string	Product Name Example: `"Computer"`	Yes
sequenceFormat	string	00000001	No
totalQuantity	number	Total Quantity Example: `100`	Yes
warehouseInventoryData	[ WarehouseInventoryData ]	Bom Assembly Details	Yes

BomAssemblyResponse

Name	Type	Description	Required
advancedTracking	string	Tracking type of product Example: `"NONE"`	No
assemblyDate	string	Assembly Date Example: `"01-07-2021"`	Yes
bomAssemblyDetails	[ BomAssemblyDetailsDto ]	Bom Assembly Details	Yes
bomMetaCode	string	BOM Meta Code Example: `"0000001"`	No
buildQuantityMax	number	Max Product Quantity that can be build Example: `10`	Yes
buildQuantityReq	number	Required Quantity to build Example: `5`	Yes
costPerUnit	number	Cost per Unit Example: `120`	Yes
customField	[ CustomFieldItem ]	List of custom fields	No
customFieldMap	object	Custom Field Columns Example: `{}`	No
documentSequenceCode	string	0000001	No
id	long	Id Example: `1234`	Yes
journalEntryCode	string	Journal Entry Code Example: `"JE-0000001"`	No
memo	string	Memo Example: `"Computer Memo"`	Yes
pid	string	pid Example: `"P-0000001"`	Yes
productCode	string	Product Code Example: `"P-0000001"`	Yes
productId	long	Product Id Example: `1234`	Yes
productName	string	Product Name Example: `"Computer"`	Yes
sequenceFormat	string	00000001	No
totalCost	number	Total Cost Example: `100`	No
totalQuantity	number	Total Quantity Example: `100`	Yes
totalQuantityAfter	number	Quantity after BOM Assembly Example: `10`	No
warehouseCode	string	Warehouse Code Example: `"WH-0000001"`	No
warehouseInventoryData	[ WarehouseInventoryData ]	Bom Assembly Details	Yes
warehouseName	string	Warehouse Name Example: `"Primary Warehouse"`	No

BomExplosionDto

Name	Type	Description	Required
advancedTracking	string	Tracking type of product Example: `"NONE"`	No
availableQuantity	double	Available Quantity of product in bom Example: `10.5`	No
bomProductConfiguration	[ BomExplosionDto ]	Bom Assembly Details	Yes
description	string	Description of product Example: `"Product"`	No
pid	string	pid Example: `"P-0000001"`	Yes
produceProductType	string	Produce Product type Enum: `"NONE"`, `"SCRAP"`, `"COPRODUCT"` Example: `"SCRAP"`	Yes
productCode	string	Product Code Example: `"P-0000001"`	Yes
productId	long	Product Id Example: `1234`	Yes
productName	string	Product Name Example: `"Computer"`	Yes
productSubstitutesDetails	[ ProductSubstitutesDetails ]	substitute details	No
productType	string	Tracking type of product Example: `"NONE"`	No
purchasePrice	double	Purchase Price of Product Example: `10.5`	No
quantityRequired	number	Quantity Required Example: `1`	Yes
reservedQuantity	double	Reserved Quantity of product in bom Example: `10.5`	No
salesPrice	double	Purchase Price of Product Example: `10.5`	No
uom	long	uom Id Example: `2`	Yes

BomMetaDetailsDto

Name	Type	Description	Required
active	boolean	bom meta details status Example: `true`	No
bomAddCostConfiguration	[ BomAdditionalCostDto ]	Bom additional cost information	No
bomOperationsConfiguration	[ BomOperationDto ]	Bom Operations information	No
bomProductCostDetails	[ BomProductCostDetails ]	JSON object for custom fields Example: `{"field1":"value1","field2":"value2"}`	No
bomProductsConfiguration	[ BomMetaDto ]	Bom Products information	No
code	string	bom meta details code Example: `"code"`	No
deleted	boolean	bom meta details delete status Example: `true`	No
id	long	id of bom meta details Example: `1234`	No
isDefault	boolean	bom default Example: `true`	No
name	string	bom meta details name Example: `"bom meta name"`	No
productId	string	id of bom product Example: `1234`	No

BomMetaDto

Name	Type	Description	Required
bomMetaDetailsId	long	id of bomMetaDetailsId Example: `1234`	No
bomMetaName	string	BOM Meta Name Example: `"DEFAULT"`	No
bomProductSubstitutesDetails	[ ProductSubstitutesDetails ]		No
cost	number	Cost of product in bom Example: `10.5`	No
itemId	long	id of item in bom Example: `1234`	No
itemName	string	Product Name Example: `"Apple"`	Yes
produceProductType	string	Produce Product type Enum: `"NONE"`, `"SCRAP"`, `"COPRODUCT"` Example: `"SCRAP"`	Yes
productCode	string		No
quantity	number	Quantity of product in bom Example: `10.5`	No
stockUom	long		No

BomOperationDto

Name	Type	Description	Required
bomMetaDetailsId	long	id of bomMetaDetailsId Example: `1234`	No
bomMetaName	string	BOM Meta Name Example: `"DEFAULT"`	No
costPerHour	number	Cost of operation in bom Example: `10.5`	No
fixedRate	number	Cost of operation in bom Example: `10.5`	No
operationId	long	id of operation in bom Example: `1234`	No
operationName	string	Operation Name Example: `"Apple"`	Yes
totalCost	number	Cost of operation in bom Example: `10.5`	No

BomProductCostDetails

Name	Type	Description	Required
operationCost	number	Operation Cost Example: `15`	No
rawMaterialCost	number	Raw material cost Example: `20`	No
totalCost	number	Total cost Example: `35`	No

BoxDto

Name	Type	Description	Required
height	string	Box width. Example: `"14 m"`	No
length	string	Box length. Example: `"10 m"`	No
type	string	BOX_S, BOX_M, BOX_L Example: `"BOX_M"`	No
width	string	Box width. Example: `"10 m"`	No

BulkApiResponse

Name	Type	Required
failure	[ object ]	No
statusCode	integer	No
success	[ object ]	No

BulkApiResponse«ContactUpdatePriceListRequest»

Name	Type	Required
failure	[ ContactUpdatePriceListRequest ]	No
statusCode	integer	No
success	[ ContactUpdatePriceListRequest ]	No

BulkApiResponse«PriceListDto»

Name	Type	Required
failure	[ PriceListDto ]	No
statusCode	integer	No
success	[ PriceListDto ]	No

ContactUpdatePriceListRequest

Name	Type	Description	Required
contactCode	string	Contact code Example: `"C-0000001"`	No
priceLists	[ long ]	Set of price lists Example: `[123,456]`	No

CustomFieldItem

Name	Type	Description	Required
id	long	Dimension Id Example: `11567`	No
label	string	Custom Field Name Example: `"Label"`	Yes
module	string	Supported Modules	No
value	object	Dimension Value Example: `"XYZ"`	No

CustomPage«ProductResponseIndia»

Name	Type	Required
content	[ ProductResponseIndia ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalOpeningValuation	double	No
totalPages	integer	No

CustomPage«ProductResponseIndonesia»

Name	Type	Required
content	[ ProductResponseIndonesia ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalOpeningValuation	double	No
totalPages	integer	No

CustomPage«ProductResponseMalaysia»

Name	Type	Required
content	[ ProductResponseMalaysia ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalOpeningValuation	double	No
totalPages	integer	No

CustomPage«ProductResponsePhilippines»

Name	Type	Required
content	[ ProductResponsePhilippines ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalOpeningValuation	double	No
totalPages	integer	No

CustomPage«ProductResponseSaudiArabia»

Name	Type	Required
content	[ ProductResponseSaudiArabia ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalOpeningValuation	double	No
totalPages	integer	No

CustomPage«ProductResponseUae»

Name	Type	Required
content	[ ProductResponseUae ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalOpeningValuation	double	No
totalPages	integer	No

CustomPage«ProductResponse»

Name	Type	Required
content	[ ProductResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalOpeningValuation	double	No
totalPages	integer	No

CustomPage«TdsNatureOfPaymentIndia»

Name	Type	Required
content	[ TdsNatureOfPaymentIndia ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalOpeningValuation	double	No
totalPages	integer	No

DocumentInfo

Name	Type	Description	Required
documentCode	string	Document Code. Example: `"QO-0000001"`	No
documentCreatedDate	dateTime	Purchase creation date Example: `"2023-01-01T00:00:00.000+0000"`	No
documentSequenceCode	string	Purchase Order Code Example: `"0000001"`	No
documentType	string	Type of document. Enum: `"QUOTATION"`, `"PURCHASE_ORDER"`, `"SALES_ORDER"`, `"PURCHASE_INVOICE"`, `"SALES_INVOICE"`, `"MAKE_PAYMENT"`, `"RECEIVE_PAYMENT"`, `"JOURNAL_ENTRY"`, `"BANK_TRANSFER"`, `"CREDIT_NOTE"`, `"DEBIT_NOTE"`, `"EXPENSE"`, `"EXPENSE_PREPAYMENT"`, `"DEPOSIT"`, `"DEPOSIT_ADVPAYMENT"`, `"CONTRA_ADJUSTMENT"`, `"GOODS_RECEIPT"`, `"FULFILLMENT"`, `"PICKLIST"`, `"PACKLIST"`, `"SHIPLIST"`, `"PAYSLIP"`, `"PAYROLL_CHECK"`, `"CHEQUE"`, `"SALES_RETURN"`, `"PURCHASE_RETURN"`, `"STOCK_ADJUSTMENT"`, `"STOCK_TRANSFER"`, `"WORK_ORDER"`, `"FIXED_ASSET"`, `"E_WAY_BILL_SUMMARY"`, `"E_WAY_BILL_DETAIL"`, `"PURCHASE_REQUEST"`, `"JOB_WORK_OUT_ORDER"`, `"JOB_WORK_OUT_TRANSFER"`, `"QC_DOCUMENT"`, `"WIP_PRODUCTION"`, `"STOCK_REQUEST"`, `"STOCK_ISSUE"`, `"FORECAST"` Example: `"QUOTATION"`	No

DocumentUOMSchemaDefinition

Name	Type	Description	Required
name	string	UOM Schema Name Example: `"UNIT"`	No
schemaId	long	UOM Schema Id Example: `1`	No
sinkConversionFactor	number	10 Example: `10`	No
sinkUOM	long	2 Example: `2`	No
sourceConversionFactor	number	1 Example: `1`	No
sourceUOM	long	4 Example: `4`	No
uid	string	UOM Schema Definition Id Example: `1`	No

File

Name	Type	Required
absolute	boolean	No
absoluteFile	File	No
absolutePath	string	No
canonicalFile	File	No
canonicalPath	string	No
directory	boolean	No
file	boolean	No
freeSpace	long	No
hidden	boolean	No
name	string	No
parent	string	No
parentFile	File	No
path	string	No
totalSpace	long	No
usableSpace	long	No

ForecastingDetails

Name	Type	Description	Required
forecastQuantity	double		No
frequencyName	string		No
periodFrequency	string	Enum: `"MONTHLY"`, `"QUARTERLY"`, `"YEARLY"`	No

FulfillmentItemDto

Name	Type	Description	Required
advancedTrackingFulfilmentData	[ AdvancedTrackingFulfilmentDto ]	Advanced tracking to fulfil list	No
advancedTrackingType	string	Advanced Tracking Type Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
availableProductQuantity	number		No
customField	[ CustomFieldItem ]	List of custom fields	No
documentItemCode	string	Document order code, It will be Quotaion/Invoice item code. Possible value - QI-00001 or II-00001 Example: `"QI-00001"`	Yes
documentSequenceCode	string	document sequence code Example: `"IN-0000001"`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
fulfilledQuantity	number	Fulfilled quantity Example: `20`	Yes
fulfillmentDate	string	fulfillment date Example: `"01-10-2019"`	No
fulfillment_item_code	string	fulfillment item specific unique code Example: `"FI-0000001"`	No
id	long		No
isPartialInvoice	boolean	Whether the document is invoice, and is partial invoice Example: `false`	No
isQuickCommit	boolean	Whether Fulfilment should be done in FIFO order Example: `false`	No
linkedPIItemCode	string	Quotation Item document sequence code Example: `"QII-0000001"`	No
pendingQuantity	number		No
productCode	string	Product code Example: `"P-0000001"`	Yes
productDescription	string		No
productName	string		No
productType	string		No
quantityRequired	number	Ordered Quantity Example: `100`	Yes
trackingInformation	[ AdvancedTrackingMetaDto ]	Advanced tracking information	No
uomAvailableProductQuantity	number		No
uomFulfilledQuantity	number	UOM Fulfilled quantity Example: `20`	No
uomName	string	UOM name	No
uomPendingQuantity	number		No
uomQuantityRequired	number	UOM Ordered Quantity Example: `100`	No
warehouseCode	string	warehouse code Example: `"WH-00001"`	No
warehouseInventoryData	[ WarehouseInventoryData ]	warehouse Inventory List Example: `[]`	No

FulfillmentRequest

Name	Type	Description	Required
attachmentIds	[ integer ]	list of attachment id's for this fulfillment	No
attachments	[ string ]	Attachments url's	No
autoFulfilled	boolean	Flag will pass as true for auto fulfilled flow. Possible value - TRUE \| FALSE Example: `false`	No
bulkItemCount	integer	count of bulk goods receipt Example: `0`	No
customField	[ CustomFieldItem ]	List of custom fields	No
documentCode	string	Document code Example: `"00001"`	Yes
documentDate	string	document creation date Example: `"01-10-2019"`	No
documentType	string	Document Type, Stage from where fulfillment is requested. Value will QUOTATION or SALES_INVOICE Example: `"QUOTATION"`	Yes
fulfillmentDate	string	fulfillment date Example: `"01-10-2019"`	No
fulfillmentItems	[ FulfillmentItemDto ]	Fulfillment item details	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: `"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
fulfillment_code	string	fulfillment specific unique code Example: `"FUL-0000001"`	No
isBulkFulfillment	boolean	true if the GR created is for bulk goods receipt Example: `true`	No
isPartialInvoice	boolean	Whether the document is invoice, and is partial invoice Example: `false`	No
isQcEnabled	boolean	Flag will pass as true for QC work flow. Possible value - TRUE \| FALSE Example: `false`	No
linkedDocuments	[ DocumentInfo ]	Linked Documents	No
linkedPIDocument	DocumentInfo	Linked Partial Invoice document.	No
parentDocumentSeqCode	string	Document Sequence code of Quote or Invoice Example: `"00001"`	No
parentFulfillmentCode	string	goods receipt specific unique code for bulk gr Example: `"FUL-0000001"`	No
reservedStock	boolean	true if the GR created is for reserved stock Example: `true`	No
sequence	integer	fulfillment group sequence Example: `1`	No
status	string	fulfillment status, possible value : PARTIAL_FULFILLED \| FULLY_FULFILLED \| UNFULFILLED Example: `"PARTIAL_FULFILLED"`	No
transactionLinkId	long	transaction link id for the goods received Example: `1`	No
warehouseCode	string	warehouse code Example: `"WH-0000001"`	No

FulfillmentResponse

Name	Type	Description	Required
attachmentIds	[ integer ]	list of attachment id's for this fulfillment	No
attachments	[ string ]	Attachments url's	No
autoFulfilled	boolean	Flag will pass as true for auto fulfilled flow. Possible value - TRUE \| FALSE Example: `false`	No
bulkItemCount	integer	count of bulk goods receipt Example: `0`	No
customField	[ CustomFieldItem ]	List of custom fields	No
documentCode	string	Document code Example: `"00001"`	Yes
documentDate	string	document creation date Example: `"01-10-2019"`	No
documentType	string	Document Type, Stage from where fulfillment is requested. Value will QUOTATION or SALES_INVOICE Example: `"QUOTATION"`	Yes
fulfillmentDate	string	fulfillment date Example: `"01-10-2019"`	No
fulfillmentItems	[ FulfillmentItemDto ]	Fulfillment item details	No
fulfillmentType	string	Fulfillment type: NONE, DEFAULT, PICK_PACK_SHIP, DROP_SHIP Enum: `"NONE"`, `"DEFAULT"`, `"PICK_PACK_SHIP"`, `"DROP_SHIP"` Example: `"PICK_PACK_SHIP"`	No
fulfillment_code	string	fulfillment specific unique code Example: `"FUL-0000001"`	No
id	long		No
isBulkFulfillment	boolean	true if the GR created is for bulk goods receipt Example: `true`	No
isPartialInvoice	boolean	Whether the document is invoice, and is partial invoice Example: `false`	No
isQcEnabled	boolean	Flag will pass as true for QC work flow. Possible value - TRUE \| FALSE Example: `false`	No
linkedDocuments	[ DocumentInfo ]	Linked Documents	No
linkedPIDocument	DocumentInfo	Linked Partial Invoice document.	No
parentDocumentSeqCode	string	Document Sequence code of Quote or Invoice Example: `"00001"`	No
parentFulfillmentCode	string	goods receipt specific unique code for bulk gr Example: `"FUL-0000001"`	No
reservedStock	boolean	true if the GR created is for reserved stock Example: `true`	No
sequence	integer	fulfillment group sequence Example: `1`	No
status	string	fulfillment status, possible value : PARTIAL_FULFILLED \| FULLY_FULFILLED \| UNFULFILLED Example: `"PARTIAL_FULFILLED"`	No
transactionLinkId	long	transaction link id for the goods received Example: `1`	No
warehouseCode	string	warehouse code Example: `"WH-0000001"`	No

GlobalDiscountDetails

Name	Type	Required
accountCode	string	No
amount	number	No
isPercent	boolean	No
isSubTotalOnly	boolean	No
name	string	No
percent	number	No

GoodsReceiptItemDto

Name	Type	Description	Required
advancedTrackingMetaData	[ AdvancedTrackingMetaDto ]		No
advancedTrackingType	string	Enum: `"NONE"`, `"BATCH"`, `"SERIAL"`	No
customField	[ CustomFieldItem ]	List of custom fields	No
documentItemCode	string	Document order code, It will be Purchase Order/Purchase Invoice item code. Possible value - POI-00001 or PII-00001 Example: `"POI-00001"`	Yes
documentSequenceCode	string	document sequence code Example: `"IN-0000001"`	No
documentUOMSchemaDefinition	DocumentUOMSchemaDefinition	Document UOM Schema Definition Example: `2`	Yes
documentUom	long	Document UOM id Example: `2`	Yes
goods_receipt_item_code	string	goods receipt item specific unique code Example: `"GRI-000001"`	No
id	long		No
pendingQuantity	number		No
productCode	string	Product code Example: `"P-0000001"`	Yes
productDescription	string		No
productName	string		No
quantityRequired	number	Purchase Ordered Quantity Example: `100`	Yes
receiptDate	string	Receipt date Example: `"01-10-2019"`	No
receiptQuantity	number	Goods Receipt quantity Example: `20`	Yes
uomName	string	UOM name	No
uomPendingQuantity	number	uom pending quantity Example: `2`	Yes
uomQuantityRequired	number	Purchase Ordered uom Quantity Example: `100`	Yes
uomReceiptQuantity	number	uom receipt quantity Example: `2`	Yes
warehouseCode	string		No
warehouseInventoryData	[ WarehouseInventoryData ]	warehouse Inventory List Example: `[]`	No

GoodsReceiptRequest

Name	Type	Description	Required
attachmentIds	[ integer ]	list of attachment id's for this gr	No
attachments	[ string ]	Attachments url's	No
autoReceipt	boolean	Flag will pass as true for auto receipt flow. Possible value - TRUE \| FALSE Example: `false`	No
bulkItemCount	integer	count of bulk goods receipt Example: `0`	No
customField	[ CustomFieldItem ]	List of custom fields	No
documentCode	string	Document code Example: `"00001"`	Yes
documentSequenceCode	string	Document code Example: `"00001"`	Yes
documentType	string	Document Type, Stage from where goods receive is requested. Value will PURCHASE_ORDER or PURCHASE_INVOICE Example: `"PURCHASE_ORDER"`	Yes
goods_receipt_code	string	goods receipt specific unique code Example: `"GR-0000001"`	No
isBulkGR	boolean	true if the GR created is for bulk goods receipt Example: `true`	No
isGoodsReceiptOfLinkedDoc	boolean	Flag will denote if GR is of a linked doc Example: `true`	No
isQcEnabled	boolean	Flag will pass as true for QC work flow. Possible value - TRUE \| FALSE Example: `false`	No
items	[ GoodsReceiptItemDto ]	Goods Receipt item details	No
linkedDocuments	[ DocumentInfo ]	Linked Documents	No
parentDocumentSeqCode	string	Document Sequence code of PO or Bill Example: `"00001"`	No
parentGrCode	string	goods receipt specific unique code for bulk gr Example: `"GR-0000001"`	No
receiptDate	string	Date on which all goods receipt successfully. Example: `"01-10-2019"`	No
sequence	integer	Goods receipt sequence Example: `1`	No
status	string	fulfillment status, possible value : UNRECEIVED \| PARTIAL_RECEIVED \| FULLY_RECEIVED Example: `"PARTIAL_FULFILLED"`	No
transactionLinkId	long	transaction link id for the goods received Example: `1`	No
warehouseCode	string	warehouse code Example: `"WH-0000001"`	No

GoodsReceiptResponse

Name	Type	Description	Required
attachmentIds	[ integer ]	list of attachment id's for this gr	No
attachments	[ string ]	Attachments url's	No
autoReceipt	boolean	Flag will pass as true for auto receipt flow. Possible value - TRUE \| FALSE Example: `false`	No
bulkItemCount	integer	count of bulk goods receipt Example: `0`	No
customField	[ CustomFieldItem ]	List of custom fields	No
documentCode	string	Document code Example: `"00001"`	Yes
documentSequenceCode	string	Document code Example: `"00001"`	Yes
documentType	string	Document Type, Stage from where goods receive is requested. Value will PURCHASE_ORDER or PURCHASE_INVOICE Example: `"PURCHASE_ORDER"`	Yes
goods_receipt_code	string	goods receipt specific unique code Example: `"GR-0000001"`	No
id	long		No
isBulkGR	boolean	true if the GR created is for bulk goods receipt Example: `true`	No
isGoodsReceiptOfLinkedDoc	boolean	Flag will denote if GR is of a linked doc Example: `true`	No
items	[ GoodsReceiptItemDto ]	Goods Receipt item details	No
linkedDocuments	[ DocumentInfo ]	Linked Documents	No
parentDocumentSeqCode	string	Document Sequence code of PO or Bill Example: `"00001"`	No
parentGrCode	string	goods receipt specific unique code for bulk gr Example: `"GR-0000001"`	No
receiptDate	string	Date on which all goods receipt successfully. Example: `"01-10-2019"`	No
sequence	integer	Goods receipt sequence Example: `1`	No
status	string	fulfillment status, possible value : UNRECEIVED \| PARTIAL_RECEIVED \| FULLY_RECEIVED Example: `"PARTIAL_FULFILLED"`	No
transactionLinkId	long	transaction link id for the goods received Example: `1`	No
warehouseCode	string	warehouse code Example: `"WH-0000001"`	No

GoodsReceiptsTypeCodeRequest

Name	Type	Description	Required
documentCodes	[ string ]		No
documentTypes	[ string ]		No

HSNAndSACCode

Name	Type	Description	Required
hsnCodes	[ HSNCodeIndiaDto ]		No
sacCodes	[ SACCodeIndiaDto ]		No

HSNCodeIndiaDto

Name	Type	Description	Required
cessNonAdvol	boolean	Cess to be applied as Nonadvol or not Example: `false`	No
cessRule	string	Cess rule expression Example: `"Math.max(21amount/100,4170quantity/1000)"`	No
cessRuleDescription	string	Cess rule description Example: `"21% or Rs. 4170 per thousand, whichever is higher"`	No
code	string	HSN code Example: `1234`	No
description	string	Description of HSN code Example: `"Cigar and cheroots"`	No
gstRate	number	GST tax percent Example: `28`	No
tenantId	long	Tenant Id Example: `123`	No

HSNCodeRequest

Name	Type	Description	Required
code	string	HSN Code Example: `123`	Yes
description	string	HSN Description Example: `"Others"`	Yes
gstRate	number	HSN GST Rate Example: `28`	Yes

ImportDataRequest

Name	Type	Required
accessToken	string	No
auditLogId	long	No
country	string	No
importDtoClassname	string	No
importDtoList	[ object ]	No
module	string	No
tenantId	long	No
userId	long	No
validRecords	[ object ]	No

IncomingDetails

Name	Type	Required
incomingQty	number	No
outgoingQty	number	No
periodName	string	No

InputStream

Name	Type	Description	Required
InputStream	object

InvWarehouseXref

Name	Type	Required
advancedTrackingMeta	[ AdvancedTrackingMeta ]	No
availableQuantity	number	No
binCode	string	No
id	long	No
inventory	Inventory	No
openingQuantity	number	No
openingValuation	number	No
productVariantCode	string	No
rackCode	string	No
reservedQuantity	number	No
rowCode	string	No
tenantId	long	No
warehouse	Warehouse	No
warehouseLevel	string	No

InvWarehouseXrefDto

Name	Type	Required
availableQuantity	number	No
binCode	string	No
id	long	No
inventoryId	long	No
openingQuantity	number	No
openingValuation	number	No
rackCode	string	No
reservedQuantity	number	No
rowCode	string	No
tenantId	long	No
warehouseId	long	No

Inventory

Name	Type	Required
active	boolean	No
advancedTrackingMeta	[ AdvancedTrackingMeta ]	No
availableQuantity	number	No
barcode	string	No
cfield	object	No
code	string	No
createdAt	dateTime	No
createdBy	long	No
customField	[ CustomFieldItem ]	No
deleted	boolean	No
id	long	No
invWarehouseXrefs	[ InvWarehouseXref ]	No
inventoryTransactions	[ InventoryTransaction ]	No
openingQuantity	number	No
openingValuation	number	No
productVariantCode	string	No
productVariantName	string	No
reorderLevel	long	No
reservedQuantity	number	No
tenantId	long	No
updatedAt	dateTime	No
updatedBy	long	No

InventoryAuditDto

Name	Type	Description	Required
adjustment_date	dateTime		No
audit_code	string		No

InventoryDto

Name	Type	Description	Required
availableQuantity	double	Available quantity Example: `100`	No
binCode	string	bin code Example: `"BIN-00001"`	Yes
binName	string	bin name Example: `"BIN-NAME"`	No
costOfGoodsSoldAccountCode	string	Cost of goods sold account code Example: `"A-10231"`	Yes
inventoryAccountCode	string	Inventory account code Example: `"A-10232"`	Yes
inventoryAccountName	string	Inventory account name Example: `"Inventory Account"`	Yes
landedCostWeight	number	Landed cost weight value Example: `10.5`	No
openingQuantity	double	Opening quantity Example: `10`	No
openingValuation	double	Opening valuation Example: `100.4`	No
rackCode	string	Rack code Example: `"RACK-00001"`	Yes
rackName	string	Rack name Example: `"RACK-NAME"`	No
reservedQuantity	double	Reserved quantity Example: `100`	No
rowCode	string	Row code Example: `"ROW-00001"`	Yes
rowName	string	Row name Example: `"ROW-NAME"`	No
stockAdjustmentAccountCode	string	Stock adjustment account code Example: `"A-10234"`	Yes
warehouseCode	string	Warehouse code Example: `"WH-00001"`	Yes
wipInventoryAccountCode	string	WIP Inventory account code Example: `"A-10233"`	Yes

InventoryRequest

Name	Type	Description	Required
costOfGoodsSoldAccountCode	string	Available quantity Example: `100`	No
inventoryAccountCode	string	Inventory account code Example: `"A-10232"`	No
openingQuantity	double	Opening quantity Example: `10`	No
openingValuation	double	Opening valuation Example: `100.4`	No
productId	long	Product id - Unique Key Example: `121`	No
stockAdjustmentAccountCode	string	Stock adjustment account code Example: `"A-10234"`	No
warehouseCode	string	Warehouse code to identify the Warehouse. Example: `"WH-0000001"`	No
wipInventoryAccountCode	string	WIP Inventory account code Example: `"A-10233"`	No

InventoryResponse

Name	Type	Description	Required
availableQuantity	double	Available quantity Example: `100`	No
binCode	string	bin code Example: `"BIN-00001"`	Yes
binName	string	bin name Example: `"BIN-NAME"`	No
costOfGoodsSoldAccountCode	string	Cost of goods sold account code Example: `"A-10231"`	Yes
inventoryAccountCode	string	Inventory account code Example: `"A-10232"`	Yes
inventoryAccountName	string	Inventory account name Example: `"Inventory Account"`	Yes
landedCostWeight	number	Landed cost weight value Example: `10.5`	No
openingQuantity	double	Opening quantity Example: `10`	No
openingValuation	double	Opening valuation Example: `100.4`	No
productId	long	Product id of the inventory Example: `121`	No
rackCode	string	Rack code Example: `"RACK-00001"`	Yes
rackName	string	Rack name Example: `"RACK-NAME"`	No
reservedQuantity	double	Reserved quantity Example: `100`	No
rowCode	string	Row code Example: `"ROW-00001"`	Yes
rowName	string	Row name Example: `"ROW-NAME"`	No
stockAdjustmentAccountCode	string	Stock adjustment account code Example: `"A-10234"`	Yes
warehouseCode	string	Warehouse code Example: `"WH-00001"`	Yes
wipInventoryAccountCode	string	WIP Inventory account code Example: `"A-10233"`	Yes

InventoryTransaction

Name	Type	Description	Required
actionType	string		No
additionalChargesAmount	number		No
advancedTrackingFulfilmentData	[ AdvancedTrackingFulfilmentDto ]		No
advancedTrackingMetaData	[ AdvancedTrackingMetaDto ]		No
binCode	string		No
contactCode	string		No
customField	object		No
customFieldItems	[ CustomFieldItem ]		No
documentCode	string		No
documentItemCode	string		No
documentSequenceCode	string		No
documentType	string		No
inventoryTxnActionType	string	Enum: `"ADD"`, `"REMOVE"`, `"DEFAULT"`	No
isQuickCommit	boolean		No
productCode	string		No
purchaseOrderCode	string		No
quantity	number		No
rackCode	string		No
reservedStock	boolean		No
rowCode	string		No
salesOrderCode	string		No
transactionDate	string	Example: `"dd-MM-yyyy HH:mm:ss"`	No
transactionRefCode	string		No
unitPrice	number		No
uomType	string	Enum: `"HOUR"`, `"UNIT"`, `"KG"`, `"PIECES"`, `"NA"`, `"DEFAULT"`	No
warehouseCode	string		No

InventoryTransactionEvent

Name	Type	Description	Required
inventoryTransactions	[ InventoryTransaction ]		No

InventoryTxnLandedCostDto

Name	Type	Description	Required
documentCode	string	Document code Example: `"PI-0000001"`	Yes
jeCode	string	Linked JE Code Example: `"JE-0000001"`	Yes
landedPrice	number	Landed Price Example: `12.5`	Yes
linkedDocumentCode	string	Linked Document code Example: `"PI-0000007"`	Yes
transactionRefCode	string	Invoice item code Example: `"PII-0000007"`	No

InventoryUpdateResponse

Name	Type	Description	Required
failInventories	[ InventoryResponse ]		No
updatedInventories	[ InventoryResponse ]		No

InventoryValuation

Name	Type	Description	Required
productValuations	[ ProductValuation ]		No
totalProduct	double	Number of Product Example: `30`	No
totalValuation	double	Total Valuation Example: `3000`	No

InventoryWarehouseDetails

Name	Type	Description	Required
availableQuantity	number	Available quantity Example: `100`	No
openingQuantity	number	Opening quantity Example: `10`	No
openingValuation	number	Opening Valuation Example: `1000`	No
warehouseCode	string	Warehouse code Example: `"WH-00001"`	Yes

LandedCostCategory

Name	Type	Description	Required
allocationType	string	Enum: `"QUANTITY"`, `"VALUE"`, `"WEIGHT"`, `"MANUAL"`, `"CUSTOM_DUTY"`	No
name	string		No

LinkedDocumentsDto

Name	Type	Description	Required
code	string		No
used	boolean		No

Location

Name	Type	Required
active	boolean	No
address	[ Address ]	No
createdAt	dateTime	No
createdBy	long	No
deleted	boolean	No
holdStocks	boolean	No
id	long	No
name	string	No
tenantId	long	No
updatedAt	dateTime	No
updatedBy	long	No

LocationDto

Name	Type	Description	Required
address	[ Address ]	List of Address.	No
id	long	Id Example: `1`	No
name	string	Name of location Example: `"Location-1"`	No

Map«long,bigdecimal»

Name	Type	Description	Required
Map«long,bigdecimal»	object

OperationCost

Name	Type	Required
id	long	No
operationCode	string	No
operationCost	number	No
operatorCost	number	No
workstationCost	number	No

PackListRequest

Name	Type	Description	Required
ppsDocuments	[ ShipmentDocumentDto ]	List of PPS documents.	No

PackListResponse

Name	Type	Description	Required
ppsDocuments	[ ShipmentDocumentDto ]	List of PPS documents.	No

PackedItemQuantityDto

Name	Type	Description	Required
packedQuantity	number	packed quantity of item in the package Example: `10`	No
shipmentDocumentItemId	long	Shipment Document Item Id Example: `2`	No
warehouseInventoryPPSData	[ WarehouseInventoryPPSData ]	Inventory Warehouse data	No

Page

Name	Type	Required
content	[ object ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer	No

Pageable

Name	Type	Required
offset	long	No
pageNumber	integer	No
pageSize	integer	No
paged	boolean	No
sort	Sort	No
unpaged	boolean	No

Page«AbstractStockIssueResponse»

Name	Type	Required
content	[ AbstractStockIssueResponse ]	No
empty	boolean	No
first	boolean	No
last	boolean	No
number	integer	No
numberOfElements	integer	No
pageable	Pageable	No
size	integer	No
sort	Sort	No
totalElements	long	No
totalPages	integer<

API​

Search Product​

Description:​

GET Product​

/v1/products​

Request URL​

Parameters​

Responses​

Responses​

Security​

Create Product​

Description:​

POST​

/v1/products​

Request URL​

Parameters​

Responses​

Security​

Update Product​

Description:​

PUT​

Products {id}​

Request URL​

Parameters​

Responses​

Security​

Get Products Paged​

GET​

Summary​

Description​

Parameters​

Responses​

Security​

POST​

Summary​

Description​

Parameters​

Responses​

Security​

DELETE​

Summary​

Description​

Parameters​

Responses​

Security​

Products activate​

PUT​

Summary​

Description​

Parameters​

Responses​

Security​

Products allproductbrief​

GET​

Summary​

Description​

Responses​

Security​

Products assign-batch​

POST​

Summary​

Parameters​

Responses​

Security​

Products barcodes​

POST​

Summary​

Description​

Parameters​

Responses​

Security​

Products brief​

GET​

Summary​

Description​

Parameters​

Responses​

Security​

Products brief-search​

GET​

API

Search Product

Description:

GET Product

/v1/products

Request URL

Parameters

Responses

Responses

Security

Create Product

Description:

POST

/v1/products

Request URL

Parameters

Responses

Security

Update Product

Description:

PUT

Products {id}

Request URL

Parameters

Responses

Security

Get Products Paged

GET

Summary

Description

Parameters

Responses

Security

POST

Summary

Description

Parameters

Responses

Security

DELETE

Summary

Description

Parameters

Responses

Security

Products activate

PUT

Summary

Description

Parameters

Responses

Security

Products allproductbrief

GET

Summary

Description

Responses

Security

Products assign-batch

POST

Summary

Parameters

Responses

Security

Products barcodes

POST

Summary

Description

Parameters

Responses

Security

Products brief

GET

Summary

Description

Parameters

Responses

Security

Products brief-search

GET