POS365.VN APIs

ProductCurrentOnHand

**Requires Authentication**
Required permission:	Product_Read

The following routes are available for this service:
All Verbs	/api/products/{Id}/currentonhand

**ProductCurrentOnHand** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	long	No

**ODataReq** Parameters:
Name	Parameter	Data Type	Required
Orderby	form	string	No
Select	form	string	No
Filter	form	string	No
Skip	form	int?	No
Top	form	int?	No

**ProductBranch** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
ProductId	form	long	No
BranchId	form	int	No
RetailerId	form	int	No
OnHand	form	double	No
OnOrder	form	double	No
MinQuantity	form	double	No
MaxQuantity	form	double	No
Cost	form	decimal	No
PriceByBranch	form	decimal	No
CreatedDate	form	DateTime	No
CreatedBy	form	long	No
ModifiedBy	form	long?	No
ModifiedDate	form	DateTime?	No
PriceByBranchLargeUnit	form	decimal	No
Product	form	Product	No

**Product** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Code	form	string	No
Name	form	string	No
AttributesName	form	string	No
CategoryId	form	long?	No
Description	form	string	No
Price	form	decimal	No
PriceLargeUnit	form	decimal	No
ProductType	form	byte	No
ConversionValue	form	double	No
Unit	form	string	No
LargeUnit	form	string	No
IsSerialNumberTracking	form	bool	No
CreatedDate	form	DateTime	No
CreatedBy	form	long	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	long?	No
RetailerId	form	int	No
IsPercentageOfTotalOrder	form	bool	No
SplitForSalesOrder	form	bool	No
OrderQuickNotes	form	string	No
Printer	form	string	No
Hidden	form	bool?	No
IsTimer	form	bool?	No
Coefficient	form	double?	No
BonusPoint	form	double	No
ShowOnBranchId	form	string	No
BonusPointForAssistant	form	double	No
BonusPointForAssistant2	form	double	No
BonusPointForAssistant3	form	double	No
PriceConfig	form	string	No
BlockOfTimeToUseService	form	int	No
IsPriceForBlock	form	bool	No
Formular	form	string	No
Position	form	long	No
LargeUnitCode	form	string	No
Code2	form	string	No
Code3	form	string	No
Code4	form	string	No
Code5	form	string	No
Category	form	Category	No
CompositeItemProducts	form	ICollection<CompositeItem>	No
ProductAttributes	form	ICollection<ProductAttribute>	No
ProductImages	form	ICollection<ProductImage>	No

**Category** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Name	form	string	No
ImageURL	form	string	No
Description	form	string	No
ParentId	form	long?	No
RetailerId	form	int	No
CreatedDate	form	DateTime	No
CreatedBy	form	long	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	long?	No
ShowOnBranchId	form	string	No
Position	form	long	No
Parent	form	Category	No

**CompositeItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
ProductId	form	long	No
ItemId	form	long	No
Quantity	form	double	No
RetailerId	form	int	No
QuantityLargeUnit	form	double	No
Item	form	Product	No

**ProductAttribute** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
ProductId	form	long	No
AttributeName	form	string	No
AttributeValue	form	string	No
RetailerId	form	int	No

**ProductImage** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
ProductId	form	long	No
ImageURL	form	string	No
ThumbnailUrl	form	string	No
IsDefault	form	bool	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/products/{Id}/currentonhand HTTP/1.1 
Host: api.pos365.vn 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	$orderby: String,
	$select: String,
	$filter: String,
	$skip: 0,
	$top: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	ProductId: 0,
	BranchId: 0,
	RetailerId: 0,
	OnHand: 0,
	OnOrder: 0,
	MinQuantity: 0,
	MaxQuantity: 0,
	Cost: 0,
	PriceByBranch: 0,
	CreatedDate: 0001-01-01,
	CreatedBy: 0,
	ModifiedBy: 0,
	ModifiedDate: 0001-01-01,
	PriceByBranchLargeUnit: 0,
	Product: 
	{
		Id: 0,
		Code: String,
		Name: String,
		AttributesName: String,
		CategoryId: 0,
		Description: String,
		Price: 0,
		PriceLargeUnit: 0,
		ProductType: 0,
		ConversionValue: 0,
		Unit: String,
		LargeUnit: String,
		IsSerialNumberTracking: False,
		CreatedDate: 0001-01-01,
		CreatedBy: 0,
		ModifiedDate: 0001-01-01,
		ModifiedBy: 0,
		RetailerId: 0,
		IsPercentageOfTotalOrder: False,
		SplitForSalesOrder: False,
		OrderQuickNotes: String,
		Printer: String,
		Hidden: False,
		IsTimer: False,
		Coefficient: 0,
		BonusPoint: 0,
		ShowOnBranchId: String,
		BonusPointForAssistant: 0,
		BonusPointForAssistant2: 0,
		BonusPointForAssistant3: 0,
		PriceConfig: String,
		BlockOfTimeToUseService: 0,
		IsPriceForBlock: False,
		Formular: String,
		Position: 0,
		LargeUnitCode: String,
		Code2: String,
		Code3: String,
		Code4: String,
		Code5: String,
		Category: 
		{
			Id: 0,
			Name: String,
			ImageURL: String,
			Description: String,
			ParentId: 0,
			RetailerId: 0,
			CreatedDate: 0001-01-01,
			CreatedBy: 0,
			ModifiedDate: 0001-01-01,
			ModifiedBy: 0,
			ShowOnBranchId: String,
			Position: 0,
			Parent: 
			{
				Id: 0,
				Name: String,
				ImageURL: String,
				Description: String,
				ParentId: 0,
				RetailerId: 0,
				CreatedDate: 0001-01-01,
				CreatedBy: 0,
				ModifiedDate: 0001-01-01,
				ModifiedBy: 0,
				ShowOnBranchId: String,
				Position: 0,
				Parent: 
				{
					Id: 0,
					Name: String,
					ImageURL: String,
					Description: String,
					ParentId: 0,
					RetailerId: 0,
					CreatedDate: 0001-01-01,
					CreatedBy: 0,
					ModifiedDate: 0001-01-01,
					ModifiedBy: 0,
					ShowOnBranchId: String,
					Position: 0
				}
			}
		}
	}
}