POST Business/Business

Retrieves a Business

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Lang": "sample string 2",
  "StoreID": 3
}

application/xml, text/xml

Sample:

<GetBusinessRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Business">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 2</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">3</StoreID>
  <ID>1</ID>
</GetBusinessRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Business

Name	Description	Type	Additional information
ID		integer	None.
Created		date	None.
Modified		date	None.
Disabled		date	None.
StoreID		integer	None.
TariffID		integer	None.
Name		string	None.
Observations	Admin observations about this business	string	None.
AuthToken	If not null, this business requires an authorization code for customer enrollment and gathering business details or contacts	string	None.
CustomerIDs		Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Created": "2025-12-06T05:42:07.2667562+01:00",
  "Modified": "2025-12-06T05:42:07.2667562+01:00",
  "Disabled": "2025-12-06T05:42:07.2667562+01:00",
  "StoreID": 4,
  "TariffID": 1,
  "Name": "sample string 5",
  "Observations": "sample string 6",
  "AuthToken": "sample string 7",
  "CustomerIDs": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<Business xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Business">
  <AuthToken>sample string 7</AuthToken>
  <Created>2025-12-06T05:42:07.2667562+01:00</Created>
  <CustomerIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </CustomerIDs>
  <Disabled>2025-12-06T05:42:07.2667562+01:00</Disabled>
  <ID>1</ID>
  <Modified>2025-12-06T05:42:07.2667562+01:00</Modified>
  <Name>sample string 5</Name>
  <Observations>sample string 6</Observations>
  <StoreID>4</StoreID>
  <TariffID>1</TariffID>
</Business>