Module POS Thương Mại

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) CommercePos Orders

Primary Key: Code

Schema

Field	Type	Description
Account	string	Account
Amount	double	Amount
Approved	string	Approved
Approver	string	Approver
Branch	string	Branch
CashAmount	double	Cash Amount
CashBack	float	Cash Back
CashReceipt	float	Cash Receipt
CashTransferAmount	double	Cash Transfer Amount
Code	string	Code
CodeTax	string	Code Tax
Contact	string	Contact
ContactAddress	string	Contact Address
ContactEmail	string	Contact Email
ContactIdentifiedNumber	string	Contact Identified Number
ContactName	string	Contact Name
ContactPhone	string	Contact Phone
Created	datetime	Created
Creator	string	Creator
DateOfDelivery	datetime	Date Of Delivery
DateOfSale	datetime	Date Of Sale
DebitFunds	double	Debit Funds
DebtAmount	string	Debt Amount
DecreaseForTotal	float	Decrease For Total
DeliveryAddress	string	Delivery Address
DeliveryLocation	numeric	Delivery Location
DirectReceiverName	string	Direct Receiver Name
Employee	string	Employee
Id	numeric	Id
IncludeTax	boolean	Include Tax
InventoryDeliveryVoucher	string	Inventory Delivery Voucher
Invoice	string	Invoice
InvoiceAddress	string	Invoice Address
InvoiceLocation	numeric	Invoice Location
IsDebt	boolean	Is Debt
IsExportVatInvoice	numeric	Is Export Vat Invoice
IsObjectRevenue	boolean	Is Object Revenue
IsPaid	numeric	Is Paid
LastUpdate	string	Last Update
MemberCard	string	Member Card
Money	string	Money
No	numeric	No
Note	string	Note
Object	string	Object
ObjectAddress	string	Object Address
ObjectBankCode	string	Object Bank Code
ObjectBankName	string	Object Bank Name
ObjectEmail	string	Object Email
ObjectIdentifiedNumber	string	Object Identified Number
ObjectName	string	Object Name
ObjectPhone	string	Object Phone
ObjectTaxCode	string	Object Tax Code
PaidMoney	string	Paid Money
PaymentMethod	string	Payment Method
Permission	string	Permission
PriceReportVoucher	string	Price Report Voucher
PriceTable	string	Price Table
PromotePrograme	string	Promote Programe
Publishers	serialize	Publishers
ReceiptBankAccount	string	Receipt Bank Account
RelativeVouchers	string	Relative Vouchers
RequireInvoice	numeric	Require Invoice
Returns	string	Returns
Revision	numeric	Revision
SalesStaff	string	Sales Staff
State	string	State
SubNote	string	Sub Note
Tax	string	Tax
Thread	string	Thread
Title	string	Title
Type	string	Type

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

• GET /v4/commerce-pos/orders/{Code}: for get exacly item

• GET /v4/commerce-pos/orders: for get multiple items

Parameters:

• token: authentication token (Type: string)

• offset: get items from offset (Type: int)

• limit: get number of items (Type: int)

• id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

• filter_<Field>: filter items by like value (Type: string)

• left_<Field>: filter items by like left of value (Type: string)

• right_<Field>: filter items by like right of value (Type: string)

• eq_<Field>: filter items by equal value (Type: string)

• ne_<Field>: filter items by not equal value (Type: string)

• lt_<Field>: filter items by less than value (Type: string)

• le_<Field>: filter items by less than or equal value (Type: string)

• gt_<Field>: filter items by greater then value (Type: string)

• ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/commerce-pos/orders

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

• PUT /v4/commerce-pos/orders/{Code}: for put exacly item

• PUT /v4/commerce-pos/orders: for put multiple items

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

• DELETE /v4/commerce-pos/orders/{Code}: for delete exacly item

• DELETE /v4/commerce-pos/orders?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) CommercePos Returns

Primary Key: Code

Schema

Field	Type	Description
Amount	string	Amount
Approved	string	Approved
Approver	string	Approver
Branch	string	Branch
CashPayment	string	Cash Payment
Code	string	Code
Contact	string	Contact
ContactAddress	string	Contact Address
ContactEmail	string	Contact Email
ContactIdentifiedNumber	string	Contact Identified Number
ContactName	string	Contact Name
ContactPhone	string	Contact Phone
Created	datetime	Created
Creator	string	Creator
DateOfReturn	datetime	Date Of Return
Employee	string	Employee
Id	numeric	Id
IncludeTax	boolean	Include Tax
Invoice	string	Invoice
InvoiceAddress	string	Invoice Address
InvoiceLocation	numeric	Invoice Location
IsDebt	boolean	Is Debt
IsImportVatInvoice	numeric	Is Import Vat Invoice
IsObjectRevenue	boolean	Is Object Revenue
LastUpdate	string	Last Update
MemberCard	string	Member Card
No	numeric	No
Note	string	Note
Object	string	Object
ObjectAddress	string	Object Address
ObjectBankCode	string	Object Bank Code
ObjectBankName	string	Object Bank Name
ObjectEmail	string	Object Email
ObjectIdentifiedNumber	string	Object Identified Number
ObjectName	string	Object Name
ObjectPhone	string	Object Phone
ObjectTaxCode	string	Object Tax Code
Order	string	Order
PaymentMethod	string	Payment Method
Permission	string	Permission
Revision	numeric	Revision
State	string	State
SubNote	string	Sub Note
Tax	string	Tax
Thread	string	Thread
Title	string	Title
Type	string	Type

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

• GET /v4/commerce-pos/returns/{Code}: for get exacly item

• GET /v4/commerce-pos/returns: for get multiple items

Parameters:

• token: authentication token (Type: string)

• offset: get items from offset (Type: int)

• limit: get number of items (Type: int)

• id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

• filter_<Field>: filter items by like value (Type: string)

• left_<Field>: filter items by like left of value (Type: string)

• right_<Field>: filter items by like right of value (Type: string)

• eq_<Field>: filter items by equal value (Type: string)

• ne_<Field>: filter items by not equal value (Type: string)

• lt_<Field>: filter items by less than value (Type: string)

• le_<Field>: filter items by less than or equal value (Type: string)

• gt_<Field>: filter items by greater then value (Type: string)

• ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/commerce-pos/returns

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

• PUT /v4/commerce-pos/returns/{Code}: for put exacly item

• PUT /v4/commerce-pos/returns: for put multiple items

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

• DELETE /v4/commerce-pos/returns/{Code}: for delete exacly item

• DELETE /v4/commerce-pos/returns?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) CommercePos Products

Primary Key: Code, WarehouseUnit

Schema

Field	Type	Description
Barcode	string	Barcode
Brand	string	Brand
BrandName	string	Brand Name
Categories	string	Categories
Code	string	Code
CostOfGoodsSoldX	string	Cost Of Goods Sold X
Created	string	Created
Creator	string	Creator
CreatorName	string	Creator Name
Description	string	Description
ExchangeProduct	string	Exchange Product
FeaturePicture	serialize	Feature Picture
Groups	string	Groups
Id	numeric	Id
IsApprove	numeric	Is Approve
IsRegenerateCode	numeric	Is Regenerate Code
IsRegenerateSku	numeric	Is Regenerate Sku
IsStopBusiness	numeric	Is Stop Business
Keyword	string	Keyword
Keywords	string	Keywords
LastUpdate	string	Last Update
LastUpdateBy	string	Last Update By
LastUpdateByName	string	Last Update By Name
ManualCode	string	Manual Code
ManufactureId	numeric	Manufacture Id
MarketingPrice	string	Marketing Price
Name	string	Name
OldCode	string	Old Code
OldCode2	string	Old Code2
Page	string	Page
ParentId	numeric	Parent Id
Permission	string	Permission
PictureId	string	Picture Id
PictureIdBk	numeric	Picture Id Bk
Pictures	serialize	Pictures
PurchaseCost	string	Purchase Cost
PurchasePrice	string	Purchase Price
RequireVatTax	numeric	Require Vat Tax
Revisions	string	Revisions
SearchRank	numeric	Search Rank
Sequence	numeric	Sequence
Sku	string	Sku
State	numeric	State
Tags	string	Tags
Tax	string	Tax
TaxName	string	Tax Name
Technical	string	Technical
Type	string	Type
TypeCode	string	Type Code
UniqueKey	string	Unique Key
UnitRatio	string	Unit Ratio
VatTax	string	Vat Tax
WarehouseUnit	string	Warehouse Unit
WarehouseUnitLabel	string	Warehouse Unit Label

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

• GET /v4/commerce-pos/products/{Code}-{WarehouseUnit}: for get exacly item

• GET /v4/commerce-pos/products: for get multiple items

Parameters:

• token: authentication token (Type: string)

• offset: get items from offset (Type: int)

• limit: get number of items (Type: int)

• id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

• filter_<Field>: filter items by like value (Type: string)

• left_<Field>: filter items by like left of value (Type: string)

• right_<Field>: filter items by like right of value (Type: string)

• eq_<Field>: filter items by equal value (Type: string)

• ne_<Field>: filter items by not equal value (Type: string)

• lt_<Field>: filter items by less than value (Type: string)

• le_<Field>: filter items by less than or equal value (Type: string)

• gt_<Field>: filter items by greater then value (Type: string)

• ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/commerce-pos/products

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

• PUT /v4/commerce-pos/products/{Code}-{WarehouseUnit}: for put exacly item

• PUT /v4/commerce-pos/products: for put multiple items

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

• DELETE /v4/commerce-pos/products/{Code}-{WarehouseUnit}: for delete exacly item

• DELETE /v4/commerce-pos/products?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) CommercePos CashVouchers

Primary Key: Code

Schema

Field	Type	Description
Amount	string	Amount
Bank	string	Bank
BankAccount	string	Bank Account
Cashbook	string	Cashbook
Code	string	Code
Created	datetime	Created
Creator	string	Creator
CreatorName	string	Creator Name
Currency	string	Currency
DateOfImplement	datetime	Date Of Implement
DateOfVoucher	datetime	Date Of Voucher
Description	string	Description
Id	numeric	Id
Object	string	Object
ObjectAddress	string	Object Address
ObjectBankAccount	string	Object Bank Account
ObjectBankName	string	Object Bank Name
ObjectEmail	string	Object Email
ObjectName	string	Object Name
ObjectPhone	string	Object Phone
ObjectTaxCode	string	Object Tax Code
Page	string	Page
Publisher	string	Publisher
RelatedUser	numeric	Related User
RelatedUserName	numeric	Related User Name
RelationVoucher	string	Relation Voucher
RelativeVouchers	string	Relative Vouchers
Returns	string	Returns
Seq	numeric	Seq
State	string	State
Type	string	Type
TypeName	string	Type Name

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

• GET /v4/commerce-pos/cash-vouchers/{Code}: for get exacly item

• GET /v4/commerce-pos/cash-vouchers: for get multiple items

Parameters:

• token: authentication token (Type: string)

• offset: get items from offset (Type: int)

• limit: get number of items (Type: int)

• id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

• filter_<Field>: filter items by like value (Type: string)

• left_<Field>: filter items by like left of value (Type: string)

• right_<Field>: filter items by like right of value (Type: string)

• eq_<Field>: filter items by equal value (Type: string)

• ne_<Field>: filter items by not equal value (Type: string)

• lt_<Field>: filter items by less than value (Type: string)

• le_<Field>: filter items by less than or equal value (Type: string)

• gt_<Field>: filter items by greater then value (Type: string)

• ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/commerce-pos/cash-vouchers

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

• PUT /v4/commerce-pos/cash-vouchers/{Code}: for put exacly item

• PUT /v4/commerce-pos/cash-vouchers: for put multiple items

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

• DELETE /v4/commerce-pos/cash-vouchers/{Code}: for delete exacly item

• DELETE /v4/commerce-pos/cash-vouchers?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) CommercePos ProductSearchIndexs

Primary Key: Id

Schema

Field	Type	Description
Barcode	string	Barcode
BaseUnit	string	Base Unit
BaseUnitLabel	string	Base Unit Label
Category	string	Category
CategoryName	string	Category Name
Code	string	Code
Container	string	Container
ContainerAccAccount	string	Container Acc Account
ContainerAccAccountName	string	Container Acc Account Name
ContainerFindOrder	numeric	Container Find Order
ContainerName	string	Container Name
ContainerShelf	string	Container Shelf
ContainerShelfName	string	Container Shelf Name
ConversionRatio	string	Conversion Ratio
Description	string	Description
DiscountCustomerGroups	string	Discount Customer Groups
DiscountDescription	string	Discount Description
DiscountPercent	string	Discount Percent
DiscountPrice	string	Discount Price
FeaturePicture	serialize	Feature Picture
Group	string	Group
GroupName	string	Group Name
Id	numeric	Id
Inventory	string	Inventory
IsAutoAdjustInventory	numeric	Is Auto Adjust Inventory
IsDefaultPurchase	numeric	Is Default Purchase
IsDefaultSales	numeric	Is Default Sales
IsExpirationGoods	numeric	Is Expiration Goods
IsManageByAccessNumber	numeric	Is Manage By Access Number
IsNotBusiness	numeric	Is Not Business
LastRebuild	string	Last Rebuild
LastUpdate	string	Last Update
Name	string	Name
Pictures	serialize	Pictures
Price	double	Price
RelativeObjectIds	string	Relative Object Ids
RelativeObjects	string	Relative Objects
SearchIndex	numeric	Search Index
SearchRank	numeric	Search Rank
SearchRankForUnit	numeric	Search Rank For Unit
SearchText	string	Search Text
Sku	string	Sku
Technical	string	Technical
Type	string	Type
Unit	string	Unit
UnitLabel	string	Unit Label
UnitNo	numeric	Unit No
UnitSeq	numeric	Unit Seq
Warehouse	string	Warehouse
WarehouseName	string	Warehouse Name
Categories	serialize	Categories
Groups	serialize	Groups

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

• GET /v4/commerce-pos/product-search-indexs/{Id}: for get exacly item

• GET /v4/commerce-pos/product-search-indexs: for get multiple items

Parameters:

• token: authentication token (Type: string)

• offset: get items from offset (Type: int)

• limit: get number of items (Type: int)

• id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

• filter_<Field>: filter items by like value (Type: string)

• left_<Field>: filter items by like left of value (Type: string)

• right_<Field>: filter items by like right of value (Type: string)

• eq_<Field>: filter items by equal value (Type: string)

• ne_<Field>: filter items by not equal value (Type: string)

• lt_<Field>: filter items by less than value (Type: string)

• le_<Field>: filter items by less than or equal value (Type: string)

• gt_<Field>: filter items by greater then value (Type: string)

• ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/commerce-pos/product-search-indexs

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

• PUT /v4/commerce-pos/product-search-indexs/{Id}: for put exacly item

• PUT /v4/commerce-pos/product-search-indexs: for put multiple items

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

• DELETE /v4/commerce-pos/product-search-indexs/{Id}: for delete exacly item

• DELETE /v4/commerce-pos/product-search-indexs?id0=123&id1=456&...: for delete multiple items with id0 id1,...

RESTFul API working with GET, POST, PUT, DELETE / RESTFul API thao tác Lấy (GET), Thêm (POST), Sửa (PUT), Xóa (DELETE) CommercePos BarcodeScanHistory

Primary Key: Id

Schema

Field	Type	Description
AccessNumber	string	Access Number
Barcode	string	Barcode
Branch	string	Branch
BranchName	string	Branch Name
DateOfScan	datetime	Date Of Scan
Description	string	Description
FeaturePicture	serialize	Feature Picture
Id	numeric	Id
Product	string	Product
RelativeOrder	string	Relative Order
Scanner	string	Scanner
ScannerName	string	Scanner Name
Type	string	Type
Unit	string	Unit
UnitLabel	string	Unit Label
Voucher	string	Voucher
VoucherType	string	Voucher Type

GET

Description: Get item or list paging by offset and limit parameters

Endpoint(s):

• GET /v4/commerce-pos/barcode-scan-history/{Id}: for get exacly item

• GET /v4/commerce-pos/barcode-scan-history: for get multiple items

Parameters:

• token: authentication token (Type: string)

• offset: get items from offset (Type: int)

• limit: get number of items (Type: int)

• id<no>: type is string and start from 0 for get one or more special items, id maybe end of enpoint / (Type: string)

• filter_<Field>: filter items by like value (Type: string)

• left_<Field>: filter items by like left of value (Type: string)

• right_<Field>: filter items by like right of value (Type: string)

• eq_<Field>: filter items by equal value (Type: string)

• ne_<Field>: filter items by not equal value (Type: string)

• lt_<Field>: filter items by less than value (Type: string)

• le_<Field>: filter items by less than or equal value (Type: string)

• gt_<Field>: filter items by greater then value (Type: string)

• ge_<Field>: filter items by greater than or equal value (Type: string)

POST

Description: Create new items

Endpoint: POST /v4/commerce-pos/barcode-scan-history

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

PUT

Description: Update items by ids

• PUT /v4/commerce-pos/barcode-scan-history/{Id}: for put exacly item

• PUT /v4/commerce-pos/barcode-scan-history: for put multiple items

Payload:

• Content-Type: application/json

• Data: JSON Array of objects defined in Schema

DELETE

Description: Delete items by ids

Endpoint(s):

• DELETE /v4/commerce-pos/barcode-scan-history/{Id}: for delete exacly item

• DELETE /v4/commerce-pos/barcode-scan-history?id0=123&id1=456&...: for delete multiple items with id0 id1,...