POST Business/Businesses
Retrieves all existing Businesses.
Request Information
URI Parameters
None.
Body Parameters
GetBusinessesRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Filter | Filter |
None. |
|
| Range | AdminFilterRange |
None. |
|
| Lang | string |
None. |
|
| StoreID | integer |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BusinessView| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalCount | integer |
None. |
|
| Businesses | Collection of Business |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalCount": 1,
"Businesses": [
{
"ID": 1,
"Created": "2025-12-06T09:18:50.9562384+01:00",
"Modified": "2025-12-06T09:18:50.9562384+01:00",
"Disabled": "2025-12-06T09:18:50.9562384+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"
]
},
{
"ID": 1,
"Created": "2025-12-06T09:18:50.9562384+01:00",
"Modified": "2025-12-06T09:18:50.9562384+01:00",
"Disabled": "2025-12-06T09:18:50.9562384+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:
<BusinessView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Business">
<Businesses>
<Business>
<AuthToken>sample string 7</AuthToken>
<Created>2025-12-06T09:18:50.9562384+01:00</Created>
<CustomerIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</CustomerIDs>
<Disabled>2025-12-06T09:18:50.9562384+01:00</Disabled>
<ID>1</ID>
<Modified>2025-12-06T09:18:50.9562384+01:00</Modified>
<Name>sample string 5</Name>
<Observations>sample string 6</Observations>
<StoreID>4</StoreID>
<TariffID>1</TariffID>
</Business>
<Business>
<AuthToken>sample string 7</AuthToken>
<Created>2025-12-06T09:18:50.9562384+01:00</Created>
<CustomerIDs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>sample string 1</d4p1:string>
<d4p1:string>sample string 2</d4p1:string>
</CustomerIDs>
<Disabled>2025-12-06T09:18:50.9562384+01:00</Disabled>
<ID>1</ID>
<Modified>2025-12-06T09:18:50.9562384+01:00</Modified>
<Name>sample string 5</Name>
<Observations>sample string 6</Observations>
<StoreID>4</StoreID>
<TariffID>1</TariffID>
</Business>
</Businesses>
<TotalCount>1</TotalCount>
</BusinessView>