| Required permission: | Stock-Setup.GET |
| GET | /Stocks/page/{Page} | Get records by given a page number | Each page consists of 20 records |
|---|---|---|---|
| GET | /Stocks/EditDate/{EditDate} | Get records that since last changed for a given date. | Each page consinsts of 20 records. |
| GET | /Stocks/StockBarcode/{StockBarcode} | Get record for given barcode | Please provide value for AcLocationID in order to get POS Price |
| GET | /Stocks/StockArticleNo/{StockArticleNo} | Get records by given Article Number | All colors and sizes of the stock would be presented if found for the given Article Number. |
| GET | /Stocks/EditDateRange/ | Get records that since last changed for a given date range (SearchEditDateFrom, SearchEditDateTo). | Each page consinsts of 20 records. |
| GET | /Stocks/StockIDList/ | Get records for given stock ID List | Multiple records could be returned for multi-uom stocks |
| GET | /Stocks/StockID/{AcStockID*} | Get records for given stock ID | Multiple records could be returned for multi-uom stocks |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Page | path | int? | No | Page Number. Default 1. |
| RecordsPerPage | query | int? | No | Records Per Page. Default 20 Records. |
| EditDate | path | DateTime? | No | Edit Date. YYYY-MM-DD. |
| AcStockID | path | string | No | Get product info by providing Stock ID |
| AcLocationID | query | string | No | Provide Location ID to get it's StockPosPrice |
| StockBarcode | path | string | No | Get product info by providing Barcode |
| AcStockIDList | query | string[] | No | Get product info by providing Stock ID list |
| IsReturnImage | query | bool | No | Indicate whether should return image data (if any). true;false |
| SearchEditDateFrom | query | DateTime? | No | Edit Date From (Search By Edit Date From). YYYY-MM-DD. |
| SearchEditDateTo | query | DateTime? | No | Edit Date To (Search By Edit Date To). YYYY-MM-DD. |
| StockArticleNo | path | string | No | Get product info by providing Stock Article Number |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Stocks | form | List<Acvw_AcStockCompany> | No | |
| ResponseStatus | form | ResponseStatus | No | |
| TotalRecords | form | int | No | Total records in all pages. |
| TotalRecordsInPage | form | int | No | Total records in current page. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AcStockID | form | NVARCHAR(40) | No | Stock ID |
| AcStockUOMID | form | NVARCHAR(20) | No | UOM ID |
| StockDescription1 | form | NVARCHAR(100) | No | Stock Description 1 |
| StockDescription2 | form | NVARCHAR(100) | No | Stock Description 2 |
| StockBalanceQuantity | form | NVARCHAR(100) | No | Stock Balance Quantity (Company Level, Converted Multi-Uom if Applicable) |
| StockBarcode | form | NVARCHAR(40) | No | Stock Barcode |
| StockArticleNo | form | NVARCHAR(20) | No | Article Number |
| StockPrice1 | form | NUMERIC(18,4) | No | Price 1 |
| StockPrice2 | form | NUMERIC(18,4) | No | Price 2 |
| StockPrice3 | form | NUMERIC(18,4) | No | Price 3 |
| StockPrice4 | form | NUMERIC(18,4) | No | Price 4 |
| StockPrice5 | form | NUMERIC(18,4) | No | Price 5 |
| QuantityMinimumLevel | form | NUMERIC(18,4) | No | Quantity Minimum Level |
| AcStockBrandID | form | NVARCHAR(20) | No | Stock Brand ID |
| AcStockGroupID | form | NVARCHAR(20) | No | Stock Group ID |
| AcStockCategoryID | form | NVARCHAR(20) | No | Stock Category ID |
| AcStockColorID | form | NVARCHAR(20) | No | Stock Color ID |
| AcStockSizeID | form | NVARCHAR(20) | No | Stock Size ID |
| AcStockUDGroup1ID | form | NVARCHAR(20) | No | Stock User Define Group 1 ID |
| AcStockUDGroup2ID | form | NVARCHAR(20) | No | Stock User Define Group 2 ID |
| AcStockUDGroup3ID | form | NVARCHAR(20) | No | Stock User Define Group 3 ID |
| AcStockBrandDesc | form | NVARCHAR(100) | No | Stock Brand Description |
| AcStockGroupDesc | form | NVARCHAR(100) | No | Stock Group Description |
| AcStockCategoryDesc | form | NVARCHAR(100) | No | Stock Category Description |
| AcStockColorDesc | form | NVARCHAR(100) | No | Stock Color Description |
| AcStockSizeDesc | form | NVARCHAR(100) | No | Stock Size Description |
| AcStockUDGroup1Desc | form | NVARCHAR(100) | No | Stock User Define Group 1 Description |
| AcStockUDGroup2Desc | form | NVARCHAR(100) | No | Stock User Define Group 2 Description |
| AcStockUDGroup3Desc | form | NVARCHAR(100) | No | Stock User Define Group 3 Description |
| EditDate | form | DATETIME | No | Record Edit DateTime |
| AccountNoSales | form | NVARCHAR(20) | No | Account Number (Sales) |
| AccountNoSalesDiscount | form | NVARCHAR(20) | No | Account Number (Sales Discount) |
| AccountNoSalesReturn | form | NVARCHAR(20) | No | Account Number (Sales Return) |
| AccountNoPurchase | form | NVARCHAR(20) | No | Account Number (Purchase) |
| AccountNoPurchaseDiscount | form | NVARCHAR(20) | No | Account Number (Purchase Discount) |
| AccountNoPurchaseReturn | form | NVARCHAR(20) | No | Account Number (Purchase Return) |
| StockPosPrice | form | NUMERIC(18,4) | No | POS Price (Value will presented if AcLocationID in parameter provided). Else 0.00 |
| StockDimensionHeight | form | NUMERIC(18,6) | No | Dimension - Height |
| StockDimensionWidth | form | NUMERIC(18,6) | No | Dimension - Width |
| StockDimensionLength | form | NUMERIC(18,6) | No | Dimension - Length |
| AcStockUOMIDDimension | form | NVARCHAR(20) | No | Dimension - UOM ID |
| StockWeight | form | NUMERIC(18,6) | No | Stock Weight |
| AcStockUOMIDWeight | form | NVARCHAR(20) | No | Stock Weight - UOM ID |
| AcStockUOMIDWeighingType | form | NVARCHAR(20) | No | Weighing Type - UOM ID |
| AcStockTypeID | form | NVARCHAR(20) | No | Stock Type ID. STOCK; SERVICE; NON-STOCK |
| StockISBN | form | NVARCHAR(100) | No | Stock ISBN |
| StockIsActive | form | NVARCHAR(1) | No | Is Active? Y: Active; N: Inactive |
| StockExtraRemark1 | form | NVARCHAR(100) | No | Stock Extra Remark 1 |
| StockExtraRemark2 | form | NVARCHAR(100) | No | Stock Extra Remark 2 |
| StockExtraRemark3 | form | NVARCHAR(100) | No | Stock Extra Remark 3 |
| StockExtraRemark4 | form | NVARCHAR(100) | No | Stock Extra Remark 4 |
| ImageDisplayBase64 | form | VARCHAR(MAX) | No | Stock Display Image in Base64 Encoding. |
| IsStockNotesAddToSales | form | NVARCHAR(1) | No | Is Stock Note add to sales? (Y/N) |
| StockNotes | form | NVARCHAR(MAX) | No | Stock Notes. Also known as Sales Notes in Dynamod Stock Maintenance. |
| IsStockNotesAddToPurchase | form | NVARCHAR(1) | No | Is Stock Note Purchase add to purchase? (Y/N) |
| StockNotesPurchase | form | NVARCHAR(MAX) | No | Stock Notes purchases. |
| StockCost | form | NUMERIC(18,4) | No | Stock Cost. |
| StockIsSerialNumber | form | NVARCHAR(1) | No | Is Serial Number Stock (Y/N) |
| AcEInvoiceItemClassificationID | form | NVARCHAR(40) | Yes | E-Invoice Item Classification ID |
| AcEInvoiceItemTaxTypeID | form | NVARCHAR(40) | Yes | E-Invoice Item Tax Type ID |
| AcTaxIDSupplySST | form | NVARCHAR(20) | Yes | Tax Code (SST) (Supply) |
| AcTaxIDPurchaseSST | form | NVARCHAR(20) | Yes | Tax Code (SST) (Purchase) |
| AcTaxIDSupply | form | NVARCHAR(20) | Yes | Tax Code (GST) (Supply) |
| AcTaxIDPurchase | form | NVARCHAR(20) | Yes | Tax Code (GST) (Purchase) |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Stocks/page/{Page} HTTP/1.1
Host: snr2u.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<StocksResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Stocks xmlns:d2p1="http://schemas.datacontract.org/2004/07/SmartDynaModWebAPI.ServiceModel.Types">
<d2p1:Acvw_AcStockCompany>
<d2p1:AcEInvoiceItemClassificationID>String</d2p1:AcEInvoiceItemClassificationID>
<d2p1:AcEInvoiceItemTaxTypeID>String</d2p1:AcEInvoiceItemTaxTypeID>
<d2p1:AcStockBrandDesc>String</d2p1:AcStockBrandDesc>
<d2p1:AcStockBrandID>String</d2p1:AcStockBrandID>
<d2p1:AcStockCategoryDesc>String</d2p1:AcStockCategoryDesc>
<d2p1:AcStockCategoryID>String</d2p1:AcStockCategoryID>
<d2p1:AcStockColorDesc>String</d2p1:AcStockColorDesc>
<d2p1:AcStockColorID>String</d2p1:AcStockColorID>
<d2p1:AcStockGroupDesc>String</d2p1:AcStockGroupDesc>
<d2p1:AcStockGroupID>String</d2p1:AcStockGroupID>
<d2p1:AcStockID>String</d2p1:AcStockID>
<d2p1:AcStockSizeDesc>String</d2p1:AcStockSizeDesc>
<d2p1:AcStockSizeID>String</d2p1:AcStockSizeID>
<d2p1:AcStockTypeID>String</d2p1:AcStockTypeID>
<d2p1:AcStockUDGroup1Desc>String</d2p1:AcStockUDGroup1Desc>
<d2p1:AcStockUDGroup1ID>String</d2p1:AcStockUDGroup1ID>
<d2p1:AcStockUDGroup2Desc>String</d2p1:AcStockUDGroup2Desc>
<d2p1:AcStockUDGroup2ID>String</d2p1:AcStockUDGroup2ID>
<d2p1:AcStockUDGroup3Desc>String</d2p1:AcStockUDGroup3Desc>
<d2p1:AcStockUDGroup3ID>String</d2p1:AcStockUDGroup3ID>
<d2p1:AcStockUOMID>String</d2p1:AcStockUOMID>
<d2p1:AcStockUOMIDDimension>String</d2p1:AcStockUOMIDDimension>
<d2p1:AcStockUOMIDWeighingType>String</d2p1:AcStockUOMIDWeighingType>
<d2p1:AcStockUOMIDWeight>String</d2p1:AcStockUOMIDWeight>
<d2p1:AcTaxIDPurchase>String</d2p1:AcTaxIDPurchase>
<d2p1:AcTaxIDPurchaseSST>String</d2p1:AcTaxIDPurchaseSST>
<d2p1:AcTaxIDSupply>String</d2p1:AcTaxIDSupply>
<d2p1:AcTaxIDSupplySST>String</d2p1:AcTaxIDSupplySST>
<d2p1:AccountNoPurchase>String</d2p1:AccountNoPurchase>
<d2p1:AccountNoPurchaseDiscount>String</d2p1:AccountNoPurchaseDiscount>
<d2p1:AccountNoPurchaseReturn>String</d2p1:AccountNoPurchaseReturn>
<d2p1:AccountNoSales>String</d2p1:AccountNoSales>
<d2p1:AccountNoSalesDiscount>String</d2p1:AccountNoSalesDiscount>
<d2p1:AccountNoSalesReturn>String</d2p1:AccountNoSalesReturn>
<d2p1:EditDate>0001-01-01T00:00:00</d2p1:EditDate>
<d2p1:ImageDisplayBase64>String</d2p1:ImageDisplayBase64>
<d2p1:IsStockNotesAddToPurchase>String</d2p1:IsStockNotesAddToPurchase>
<d2p1:IsStockNotesAddToSales>String</d2p1:IsStockNotesAddToSales>
<d2p1:QuantityMinimumLevel>0</d2p1:QuantityMinimumLevel>
<d2p1:StockArticleNo>String</d2p1:StockArticleNo>
<d2p1:StockBalanceQuantity>0</d2p1:StockBalanceQuantity>
<d2p1:StockBarcode>String</d2p1:StockBarcode>
<d2p1:StockCost>0</d2p1:StockCost>
<d2p1:StockDescription1>String</d2p1:StockDescription1>
<d2p1:StockDescription2>String</d2p1:StockDescription2>
<d2p1:StockDimensionHeight>0</d2p1:StockDimensionHeight>
<d2p1:StockDimensionLength>0</d2p1:StockDimensionLength>
<d2p1:StockDimensionWidth>0</d2p1:StockDimensionWidth>
<d2p1:StockExtraRemark1>String</d2p1:StockExtraRemark1>
<d2p1:StockExtraRemark2>String</d2p1:StockExtraRemark2>
<d2p1:StockExtraRemark3>String</d2p1:StockExtraRemark3>
<d2p1:StockExtraRemark4>String</d2p1:StockExtraRemark4>
<d2p1:StockISBN>String</d2p1:StockISBN>
<d2p1:StockIsActive>String</d2p1:StockIsActive>
<d2p1:StockIsSerialNumber>String</d2p1:StockIsSerialNumber>
<d2p1:StockNotes>String</d2p1:StockNotes>
<d2p1:StockNotesPurchase>String</d2p1:StockNotesPurchase>
<d2p1:StockPosPrice>0</d2p1:StockPosPrice>
<d2p1:StockPrice1>0</d2p1:StockPrice1>
<d2p1:StockPrice2>0</d2p1:StockPrice2>
<d2p1:StockPrice3>0</d2p1:StockPrice3>
<d2p1:StockPrice4>0</d2p1:StockPrice4>
<d2p1:StockPrice5>0</d2p1:StockPrice5>
<d2p1:StockWeight>0</d2p1:StockWeight>
</d2p1:Acvw_AcStockCompany>
</Stocks>
<TotalRecords>0</TotalRecords>
<TotalRecordsInPage>0</TotalRecordsInPage>
</StocksResponse>