GET api/SIMS/GetStockDetailByReplicationIdPaginated?replicationId={replicationId}&page={page}&pageSize={pageSize}&companyKey={companyKey}
Gets a list of stock items limited to a certain number according to the page number provided and the page size limitation provided
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| replicationId |
The replication ID for which to get stock card details. Note: The ID may need to one or more have 0s added at the beginning for the endpoint to work properly. |
string |
Required |
| page |
The number of pages to be returned |
string |
Required |
| pageSize |
The number of items per page |
string |
Required |
| companyKey |
The company name if the service is connected to multiple SIMS companies (Optional) |
string |
Default value is |
Body Parameters
N/A
Response Information
Resource Description
The specific page of stock details depending on the page and page size chosen
ApiStockCardPaginated| Name | Description | Type | Additional information |
|---|---|---|---|
| Page | integer |
N/A |
|
| ItemsPerPage | integer |
N/A |
|
| TotalPages | integer |
N/A |
|
| TotalItems | integer |
N/A |
|
| StockDetails | Collection of ApiStockCard |
N/A |
Response Formats
application/json, text/json
Sample:
{
"Page": 1,
"ItemsPerPage": 2,
"TotalPages": 3,
"TotalItems": 4,
"StockDetails": [
{
"StockCode": "sample string 1",
"Description": "sample string 2",
"AlternateCode": "sample string 3",
"SupplierStockCode": "sample string 4",
"Location": "sample string 5",
"Unit": "sample string 6",
"Category": "sample string 7",
"StockGroup": "sample string 8",
"Department": "sample string 9",
"HsCode": "sample string 10",
"Supplier": "sample string 11",
"AlternateSupplier": "sample string 12",
"Model": "sample string 13",
"Quantity": 14.0,
"Vatrate": 15.0,
"Vatcode": "sample string 16",
"PackSize": 17.0,
"Leadtime": 19.0,
"NonInventory": true,
"Withdrawn": true,
"Mode": 0,
"LastIssue": "2025-12-26T22:56:31.0613438",
"LastReceipt": "2025-12-26T22:56:31.0613438",
"DiscountSales": 24.0,
"DiscountPurchase": 25.0,
"Classifier": "sample string 26",
"OnSalesOrder": 27.0,
"OnPurchaseOrder": 28.0,
"EcoTax": 29.0,
"GuaranteeCode": "sample string 30",
"LastPurchasedQty": 31.0,
"Size": "sample string 32",
"Style": "sample string 33",
"Color": "sample string 34",
"Currency1": "sample string 35",
"Currency2": "sample string 36",
"Currency3": "sample string 37",
"Currency4": "sample string 38",
"Currency5": "sample string 39",
"Currency6": "sample string 40",
"Selling1": 41.0,
"Selling2": 42.0,
"Selling3": 43.0,
"Selling4": 44.0,
"Selling5": 45.0,
"Selling6": 46.0,
"Selling1IncVAT": 47.0,
"Selling2IncVAT": 48.0,
"Selling3IncVAT": 49.0,
"Selling4IncVAT": 50.0,
"Selling5IncVAT": 51.0,
"Selling6IncVAT": 52.0,
"LastPurchaseCurreny": "sample string 55",
"Remarks": "sample string 56",
"Generic1": "sample string 57",
"Generic2": "sample string 58",
"Generic3": "sample string 59",
"Generic4": "sample string 60",
"Generic5": "sample string 61",
"Generic6": "sample string 62",
"Generic7": "sample string 63",
"Generic8": "sample string 64",
"Generic9": "sample string 65",
"Generic10": "sample string 66",
"Generic11": 67.0,
"Generic12": 68.0,
"Generic13": 69.0,
"Generic14": "2025-12-26T22:56:31.0613438",
"Generic15": "2025-12-26T22:56:31.0613438",
"Generic16": true,
"Generic17": true,
"Generic18": true,
"Generic19": true,
"Generic20": true,
"Generic21": 77.0,
"Generic22": 78.0,
"Generic23": "2025-12-26T22:56:31.0613438",
"Generic24": "2025-12-26T22:56:31.0613438",
"Generic25": "2025-12-26T22:56:31.0613438",
"Generic26": 82.0,
"Generic27": 83.0,
"Generic28": 84.0,
"Generic29": "sample string 85",
"Generic30": "sample string 86",
"Generic31": "sample string 87",
"Generic32": "sample string 88",
"Generic33": "sample string 89",
"Generic34": "sample string 90",
"Generic35": "sample string 91",
"Generic36": "sample string 92",
"Generic37": "sample string 93",
"ReplicationID": "sample string 94",
"CreatedOn": "2025-12-26T22:56:31.0613438",
"AmendedOn": "2025-12-26T22:56:31.0613438",
"Weight": 97.0,
"Season": "sample string 98",
"MinSalePrice": 99.0,
"MaxSalePrice": 100.0,
"BcrsUnits": 101
},
{
"StockCode": "sample string 1",
"Description": "sample string 2",
"AlternateCode": "sample string 3",
"SupplierStockCode": "sample string 4",
"Location": "sample string 5",
"Unit": "sample string 6",
"Category": "sample string 7",
"StockGroup": "sample string 8",
"Department": "sample string 9",
"HsCode": "sample string 10",
"Supplier": "sample string 11",
"AlternateSupplier": "sample string 12",
"Model": "sample string 13",
"Quantity": 14.0,
"Vatrate": 15.0,
"Vatcode": "sample string 16",
"PackSize": 17.0,
"Leadtime": 19.0,
"NonInventory": true,
"Withdrawn": true,
"Mode": 0,
"LastIssue": "2025-12-26T22:56:31.0613438",
"LastReceipt": "2025-12-26T22:56:31.0613438",
"DiscountSales": 24.0,
"DiscountPurchase": 25.0,
"Classifier": "sample string 26",
"OnSalesOrder": 27.0,
"OnPurchaseOrder": 28.0,
"EcoTax": 29.0,
"GuaranteeCode": "sample string 30",
"LastPurchasedQty": 31.0,
"Size": "sample string 32",
"Style": "sample string 33",
"Color": "sample string 34",
"Currency1": "sample string 35",
"Currency2": "sample string 36",
"Currency3": "sample string 37",
"Currency4": "sample string 38",
"Currency5": "sample string 39",
"Currency6": "sample string 40",
"Selling1": 41.0,
"Selling2": 42.0,
"Selling3": 43.0,
"Selling4": 44.0,
"Selling5": 45.0,
"Selling6": 46.0,
"Selling1IncVAT": 47.0,
"Selling2IncVAT": 48.0,
"Selling3IncVAT": 49.0,
"Selling4IncVAT": 50.0,
"Selling5IncVAT": 51.0,
"Selling6IncVAT": 52.0,
"LastPurchaseCurreny": "sample string 55",
"Remarks": "sample string 56",
"Generic1": "sample string 57",
"Generic2": "sample string 58",
"Generic3": "sample string 59",
"Generic4": "sample string 60",
"Generic5": "sample string 61",
"Generic6": "sample string 62",
"Generic7": "sample string 63",
"Generic8": "sample string 64",
"Generic9": "sample string 65",
"Generic10": "sample string 66",
"Generic11": 67.0,
"Generic12": 68.0,
"Generic13": 69.0,
"Generic14": "2025-12-26T22:56:31.0613438",
"Generic15": "2025-12-26T22:56:31.0613438",
"Generic16": true,
"Generic17": true,
"Generic18": true,
"Generic19": true,
"Generic20": true,
"Generic21": 77.0,
"Generic22": 78.0,
"Generic23": "2025-12-26T22:56:31.0613438",
"Generic24": "2025-12-26T22:56:31.0613438",
"Generic25": "2025-12-26T22:56:31.0613438",
"Generic26": 82.0,
"Generic27": 83.0,
"Generic28": 84.0,
"Generic29": "sample string 85",
"Generic30": "sample string 86",
"Generic31": "sample string 87",
"Generic32": "sample string 88",
"Generic33": "sample string 89",
"Generic34": "sample string 90",
"Generic35": "sample string 91",
"Generic36": "sample string 92",
"Generic37": "sample string 93",
"ReplicationID": "sample string 94",
"CreatedOn": "2025-12-26T22:56:31.0613438",
"AmendedOn": "2025-12-26T22:56:31.0613438",
"Weight": 97.0,
"Season": "sample string 98",
"MinSalePrice": 99.0,
"MaxSalePrice": 100.0,
"BcrsUnits": 101
}
]
}