The Shireburn Business Suite (SBS) API enables you to interact with SBS systems. You will need an API key which should be passed as a query string with each of the requests below.

GET api/SIMS/GetStockDetailByStyle?style={style}&companyKey={companyKey}

Gets the stock card details specified by style.

Request Information

URI Parameters

Name	Description	Type	Additional information
style	Stock style	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 quantity

Collection of ApiStockCard

Name	Type	Additional information
StockCode	string	N/A
Description	string	N/A
AlternateCode	string	N/A
SupplierStockCode	string	N/A
Location	string	N/A
Unit	string	N/A
Category	string	N/A
StockGroup	string	N/A
Department	string	N/A
HsCode	string	N/A
Supplier	string	N/A
AlternateSupplier	string	N/A
Model	string	N/A
Quantity	decimal number	N/A
Vatrate	decimal number	N/A
Vatcode	string	N/A
PackSize	decimal number	N/A
AverageCost	decimal number	N/A
Leadtime	decimal number	N/A
NonInventory	boolean	N/A
Withdrawn	boolean	N/A
Mode	StockMode	N/A
LastIssue	date	N/A
LastReceipt	date	N/A
DiscountSales	decimal number	N/A
DiscountPurchase	decimal number	N/A
Classifier	string	N/A
OnSalesOrder	decimal number	N/A
OnPurchaseOrder	decimal number	N/A
EcoTax	decimal number	N/A
GuaranteeCode	string	N/A
LastPurchasedQty	decimal number	N/A
Size	string	N/A
Style	string	N/A
Color	string	N/A
Currency1	string	N/A
Currency2	string	N/A
Currency3	string	N/A
Currency4	string	N/A
Currency5	string	N/A
Currency6	string	N/A
Selling1	decimal number	N/A
Selling2	decimal number	N/A
Selling3	decimal number	N/A
Selling4	decimal number	N/A
Selling5	decimal number	N/A
Selling6	decimal number	N/A
Selling1IncVAT	decimal number	N/A
Selling2IncVAT	decimal number	N/A
Selling3IncVAT	decimal number	N/A
Selling4IncVAT	decimal number	N/A
Selling5IncVAT	decimal number	N/A
Selling6IncVAT	decimal number	N/A
LastCost	decimal number	N/A
LastPurchaseCurreny	string	N/A
Remarks	string	N/A
Generic1	string	N/A
Generic2	string	N/A
Generic3	string	N/A
Generic4	string	N/A
Generic5	string	N/A
Generic6	string	N/A
Generic7	string	N/A
Generic8	string	N/A
Generic9	string	N/A
Generic10	string	N/A
Generic11	decimal number	N/A
Generic12	decimal number	N/A
Generic13	decimal number	N/A
Generic14	date	N/A
Generic15	date	N/A
Generic16	boolean	N/A
Generic17	boolean	N/A
Generic18	boolean	N/A
Generic19	boolean	N/A
Generic20	boolean	N/A
Generic21	decimal number	N/A
Generic22	decimal number	N/A
Generic23	date	N/A
Generic24	date	N/A
Generic25	date	N/A
Generic26	decimal number	N/A
Generic27	decimal number	N/A
Generic28	decimal number	N/A
Generic29	string	N/A
Generic30	string	N/A
Generic31	string	N/A
Generic32	string	N/A
Generic33	string	N/A
Generic34	string	N/A
Generic35	string	N/A
Generic36	string	N/A
Generic37	string	N/A
ReplicationID	string	N/A
CreatedOn	date	N/A
AmendedOn	date	N/A
Weight	decimal number	N/A
Season	string	N/A
MinSalePrice	decimal number	N/A
MaxSalePrice	decimal number	N/A

Response Formats

application/json, text/json

Sample:

[
  {
    "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": "2024-11-23T17:54:35.5015783",
    "LastReceipt": "2024-11-23T17:54:35.5015783",
    "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": "2024-11-23T17:54:35.5015783",
    "Generic15": "2024-11-23T17:54:35.5015783",
    "Generic16": true,
    "Generic17": true,
    "Generic18": true,
    "Generic19": true,
    "Generic20": true,
    "Generic21": 77.0,
    "Generic22": 78.0,
    "Generic23": "2024-11-23T17:54:35.5015783",
    "Generic24": "2024-11-23T17:54:35.5015783",
    "Generic25": "2024-11-23T17:54:35.5015783",
    "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": "2024-11-23T17:54:35.5015783",
    "AmendedOn": "2024-11-23T17:54:35.5015783",
    "Weight": 97.0,
    "Season": "sample string 98",
    "MinSalePrice": 99.0,
    "MaxSalePrice": 100.0
  },
  {
    "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": "2024-11-23T17:54:35.5015783",
    "LastReceipt": "2024-11-23T17:54:35.5015783",
    "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": "2024-11-23T17:54:35.5015783",
    "Generic15": "2024-11-23T17:54:35.5015783",
    "Generic16": true,
    "Generic17": true,
    "Generic18": true,
    "Generic19": true,
    "Generic20": true,
    "Generic21": 77.0,
    "Generic22": 78.0,
    "Generic23": "2024-11-23T17:54:35.5015783",
    "Generic24": "2024-11-23T17:54:35.5015783",
    "Generic25": "2024-11-23T17:54:35.5015783",
    "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": "2024-11-23T17:54:35.5015783",
    "AmendedOn": "2024-11-23T17:54:35.5015783",
    "Weight": 97.0,
    "Season": "sample string 98",
    "MinSalePrice": 99.0,
    "MaxSalePrice": 100.0
  }
]