Requires any of the permissions: | Product_Update, Product_Create |
POST | /api/products |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Product | body | Product | No | |
OnHand | body | double | No | |
CompareOnHand | body | double | No | |
MinQuantity | body | double | No | |
MaxQuantity | body | double | No | |
Cost | body | decimal | No | |
CompareCost | body | decimal | No | |
PriceByBranch | body | decimal | No | |
PriceByBranchLargeUnit | body | decimal | No | |
ProductPartners | body | List<ProductPartner> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
ProductId | form | long | No | |
AttributeName | form | string | No | |
AttributeValue | form | string | No | |
RetailerId | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
ProductId | form | long | No | |
ImageURL | form | string | No | |
ThumbnailUrl | form | string | No | |
IsDefault | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
ProductId | form | long | No | |
PartnerId | form | long | No | |
Cost | form | decimal | No | |
PlanToChangeCost | form | DateTime? | No | |
NewCost | form | decimal | No | |
RetailerId | form | int | No | |
CreatedDate | form | DateTime | No | |
CreatedBy | form | long | No | |
Partner | form | Partner | No | |
Product | form | Product | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PlainPassword | form | string | No | |
Id | form | long | No | |
Code | form | string | No | |
Name | form | string | No | |
Address | form | string | No | |
Phone | form | string | No | |
DOB | form | DateTime? | No | |
form | string | No | ||
Type | form | byte | No | |
Gender | form | byte | No | |
TaxCode | form | string | No | |
TotalDebt | form | decimal | No | |
Loyalty | form | decimal | No | |
Description | form | string | No | |
CreatedBy | form | long | No | |
CreatedDate | form | DateTime | No | |
ModifiedBy | form | long? | No | |
ModifiedDate | form | DateTime? | No | |
RetailerId | form | int | No | |
Image | form | string | No | |
IdentifyNo | form | string | No | |
LeadOwnerId | form | long? | No | |
Company | form | string | No | |
Department | form | string | No | |
Password | form | string | No | |
Province | form | string | No | |
Point | form | long | No | |
ShippingAddress | form | string | No | |
Phone2 | form | string | No | |
MemberJoinDate | form | DateTime? | No | |
Transactionvalue | form | decimal | No | |
LeadOwner | form | User | No | |
PartnerGroupMembers | form | ICollection<PartnerGroupMember> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PlainPassword | form | string | No | |
Id | form | long | No | |
form | string | No | ||
UserName | form | string | No | |
Password | form | string | No | |
Name | form | string | No | |
DOB | form | DateTime? | No | |
Address | form | string | No | |
Phone | form | string | No | |
CreatedDate | form | DateTime | No | |
IsActive | form | bool | No | |
IsAdmin | form | bool | No | |
RetailerId | form | int | No | |
CreatedBy | form | long | No | |
AdminGroup | form | byte | No | |
ManagedBy | form | long? | No | |
IdentityCardNumber | form | string | No | |
ManagedByNavigation | form | User | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
PartnerId | form | long | No | |
GroupId | form | long | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
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 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/products HTTP/1.1
Host: api.pos365.vn
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
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
}
}
}
},
OnHand: 0,
CompareOnHand: 0,
MinQuantity: 0,
MaxQuantity: 0,
Cost: 0,
CompareCost: 0,
PriceByBranch: 0,
PriceByBranchLargeUnit: 0,
ProductPartners:
[
{
Id: 0,
ProductId: 0,
PartnerId: 0,
Cost: 0,
PlanToChangeCost: 0001-01-01,
NewCost: 0,
RetailerId: 0,
CreatedDate: 0001-01-01,
CreatedBy: 0,
Partner:
{
PlainPassword: String,
Id: 0,
Code: String,
Name: String,
Address: String,
Phone: String,
DOB: 0001-01-01,
Email: String,
Type: 0,
Gender: 0,
TaxCode: String,
TotalDebt: 0,
Loyalty: 0,
Description: String,
CreatedBy: 0,
CreatedDate: 0001-01-01,
ModifiedBy: 0,
ModifiedDate: 0001-01-01,
RetailerId: 0,
Image: String,
IdentifyNo: String,
LeadOwnerId: 0,
Company: String,
Department: String,
Password: String,
Province: String,
Point: 0,
ShippingAddress: String,
Phone2: String,
MemberJoinDate: 0001-01-01,
Transactionvalue: 0,
LeadOwner:
{
PlainPassword: String,
Id: 0,
Email: String,
UserName: String,
Password: String,
Name: String,
DOB: 0001-01-01,
Address: String,
Phone: String,
CreatedDate: 0001-01-01,
IsActive: False,
IsAdmin: False,
RetailerId: 0,
CreatedBy: 0,
AdminGroup: 0,
ManagedBy: 0,
IdentityCardNumber: String,
ManagedByNavigation:
}
},
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:
}
}
}
}
]
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { 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 } } } }