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/GetStockExtWeb?companyKey={companyKey}

Gets all the records in the stock ext web table in the database

Request Information

URI Parameters

Name	Description	Type	Additional information
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 records in the stock ext web table

Collection of StockExtWeb

Name	Description	Type	Additional information
StockCode	The stock code of the stock ext web	string	N/A
ShortDesc	The short description of the stock	string	N/A
FullDesc	The full description of the stock	string	N/A
Comment	Any comment linked with the Stock Ext Web record	string	N/A
Publish	Publish of the Stock Ext Web record	boolean	N/A
PubDate	The date of the publication date	date	N/A
Supplier	The supplier of the stock	string	N/A
MetaKey	The meta key of the record	string	N/A
MetaDesc	The description of the meta record	string	N/A
MetaTitle	The title of the meta record	string	N/A
SeName		string	N/A
AlwReview	Check if reviews allowed	boolean	N/A
AlwRating	Check if ratings allowed	boolean	N/A
OosAction		string	N/A
HtmlDesc	Description for HTML	string	N/A
CreatedBy	User who created the record	string	N/A
AmendedBy	User who amended the record (if any)	string	N/A
CreatedOn	Date of creation of the record	date	N/A
AmendedOn	Date when the record was amended (if any)	date	N/A
MinPubQty	Minimum quantity	decimal number	N/A
ReplicId	Replic ID of the stock item	string	N/A

Response Formats

application/json, text/json

Sample:

[
  {
    "StockCode": "sample string 1",
    "ShortDesc": "sample string 2",
    "FullDesc": "sample string 3",
    "Comment": "sample string 4",
    "Publish": true,
    "PubDate": "2025-12-26T22:51:07.4837356",
    "Supplier": "sample string 7",
    "MetaKey": "sample string 8",
    "MetaDesc": "sample string 9",
    "MetaTitle": "sample string 10",
    "SeName": "sample string 11",
    "AlwReview": true,
    "AlwRating": true,
    "OosAction": "sample string 14",
    "HtmlDesc": "sample string 15",
    "CreatedBy": "sample string 16",
    "AmendedBy": "sample string 17",
    "CreatedOn": "2025-12-26T22:51:07.4837356",
    "AmendedOn": "2025-12-26T22:51:07.4837356",
    "MinPubQty": 20.0,
    "ReplicId": "sample string 21"
  },
  {
    "StockCode": "sample string 1",
    "ShortDesc": "sample string 2",
    "FullDesc": "sample string 3",
    "Comment": "sample string 4",
    "Publish": true,
    "PubDate": "2025-12-26T22:51:07.4837356",
    "Supplier": "sample string 7",
    "MetaKey": "sample string 8",
    "MetaDesc": "sample string 9",
    "MetaTitle": "sample string 10",
    "SeName": "sample string 11",
    "AlwReview": true,
    "AlwRating": true,
    "OosAction": "sample string 14",
    "HtmlDesc": "sample string 15",
    "CreatedBy": "sample string 16",
    "AmendedBy": "sample string 17",
    "CreatedOn": "2025-12-26T22:51:07.4837356",
    "AmendedOn": "2025-12-26T22:51:07.4837356",
    "MinPubQty": 20.0,
    "ReplicId": "sample string 21"
  }
]