POST api/Business/GetAddressSettings
Request Information
URI Parameters
None.
Body Parameters
GetBaseBusinessAddressSettingsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| BusinessAddressId | integer |
None. |
|
| BusinessAddressIds | Collection of integer |
None. |
|
| listofsync | Collection of Storedata |
None. |
|
| CustomerId | integer |
None. |
|
| UserId | integer |
None. |
|
| Token | globally unique identifier |
None. |
|
| BusinessId | integer |
None. |
|
| Id | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"BusinessAddressId": 1,
"BusinessAddressIds": [
1,
1
],
"listofsync": [
{
"TableName": "sample string 1",
"LastSync": "2026-03-20T14:27:35.6568528+00:00"
},
{
"TableName": "sample string 1",
"LastSync": "2026-03-20T14:27:35.6568528+00:00"
}
],
"CustomerId": 1,
"UserId": 1,
"Token": "405da4ea-8ba8-49f0-8904-65555880d97f",
"BusinessId": 1,
"Id": 1
}
application/xml, text/xml
Sample:
<GetBaseBusinessAddressSettingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TAG.ReqResp">
<Id>1</Id>
<BusinessAddressId>1</BusinessAddressId>
<BusinessAddressIds xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:long>1</d2p1:long>
<d2p1:long>1</d2p1:long>
</BusinessAddressIds>
<BusinessId>1</BusinessId>
<CustomerId>1</CustomerId>
<Token>405da4ea-8ba8-49f0-8904-65555880d97f</Token>
<UserId>1</UserId>
<listofsync>
<Storedata>
<LastSync>2026-03-20T14:27:35.6568528+00:00</LastSync>
<TableName>sample string 1</TableName>
</Storedata>
<Storedata>
<LastSync>2026-03-20T14:27:35.6568528+00:00</LastSync>
<TableName>sample string 1</TableName>
</Storedata>
</listofsync>
</GetBaseBusinessAddressSettingsRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
GetBaseBusinessAddressSettingsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Status | boolean |
None. |
|
| Message | string |
None. |
|
| Token | globally unique identifier |
None. |
|
| BaseObjects | Collection of BaseBusinessAddressSettingModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"Status": true,
"Message": "sample string 2",
"Token": "23e8c735-9954-423a-bb9c-a87697b27ce3",
"BaseObjects": [
{
"BusinessAddressId": 1,
"CollectionInterval": 2,
"DeliveryInterval": 3,
"DeliveryStartIn": 4,
"DeliveryDistance": 5,
"MinimumDeliveryValue": 6.0,
"MinimumDeliveryCost": 7.0,
"CollectionEnabled": true,
"DeliveryEnabled": true,
"IsDeleted": true,
"SendNewOrderEmailEnabled": true,
"BeepDeviceOnNewOrderEnabled": true,
"PrintNewOrderReceiptEnabled": true,
"OrderOnDevice": true,
"OrderOnPrinter": true,
"MinimumDeliveryFixed": true,
"MinimumDeliveryFixedValue": 1.0,
"OrderNo": 1,
"PrintNewOrderReceiptAuto": true,
"BeepDeviceOnNewOrderContinuously": true,
"MessageText": "sample string 13",
"MessageForeColour": "sample string 14",
"MessageBackColour": "sample string 15",
"SendNewOrderSMSEnabled": true,
"TableReservationEnabled": true,
"ChickenToMe": true,
"RightMessageText": "sample string 19",
"RightMessageForeColour": "sample string 20",
"RightMessageBackColour": "sample string 21",
"allergens": "sample string 22",
"URL": "sample string 23",
"Target": "sample string 24",
"Name": "sample string 25",
"TableEnabled": true,
"PreOrderStatus": true,
"NumberOfOrders": 1,
"CategoryActiveText": "sample string 26",
"Actionbuttontext": "sample string 27",
"HomePageText": "sample string 28",
"HeaderText": "sample string 29",
"CategoryHoverText": "sample string 30",
"CategoryHoverBackground": "sample string 31",
"CategoryActiveBackground": "sample string 32",
"ScrollbarBackground": "sample string 33",
"ScrollbarForeground": "sample string 34",
"NumberOfReceipts": 1,
"CreatedBy": 1,
"ModifiedBy": 1,
"CreatedDate": "2026-03-20T14:27:35.6724781+00:00",
"LastUpdated": "2026-03-20T14:27:35.6724781+00:00",
"Id": 1
},
{
"BusinessAddressId": 1,
"CollectionInterval": 2,
"DeliveryInterval": 3,
"DeliveryStartIn": 4,
"DeliveryDistance": 5,
"MinimumDeliveryValue": 6.0,
"MinimumDeliveryCost": 7.0,
"CollectionEnabled": true,
"DeliveryEnabled": true,
"IsDeleted": true,
"SendNewOrderEmailEnabled": true,
"BeepDeviceOnNewOrderEnabled": true,
"PrintNewOrderReceiptEnabled": true,
"OrderOnDevice": true,
"OrderOnPrinter": true,
"MinimumDeliveryFixed": true,
"MinimumDeliveryFixedValue": 1.0,
"OrderNo": 1,
"PrintNewOrderReceiptAuto": true,
"BeepDeviceOnNewOrderContinuously": true,
"MessageText": "sample string 13",
"MessageForeColour": "sample string 14",
"MessageBackColour": "sample string 15",
"SendNewOrderSMSEnabled": true,
"TableReservationEnabled": true,
"ChickenToMe": true,
"RightMessageText": "sample string 19",
"RightMessageForeColour": "sample string 20",
"RightMessageBackColour": "sample string 21",
"allergens": "sample string 22",
"URL": "sample string 23",
"Target": "sample string 24",
"Name": "sample string 25",
"TableEnabled": true,
"PreOrderStatus": true,
"NumberOfOrders": 1,
"CategoryActiveText": "sample string 26",
"Actionbuttontext": "sample string 27",
"HomePageText": "sample string 28",
"HeaderText": "sample string 29",
"CategoryHoverText": "sample string 30",
"CategoryHoverBackground": "sample string 31",
"CategoryActiveBackground": "sample string 32",
"ScrollbarBackground": "sample string 33",
"ScrollbarForeground": "sample string 34",
"NumberOfReceipts": 1,
"CreatedBy": 1,
"ModifiedBy": 1,
"CreatedDate": "2026-03-20T14:27:35.6724781+00:00",
"LastUpdated": "2026-03-20T14:27:35.6724781+00:00",
"Id": 1
}
]
}
application/xml, text/xml
Sample:
<GetBaseBusinessAddressSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TAG.ReqResp">
<BaseObjects xmlns:d2p1="http://schemas.datacontract.org/2004/07/TAG.DataModels">
<d2p1:BaseBusinessAddressSettingModel>
<d2p1:Id>1</d2p1:Id>
<d2p1:CreatedDate>2026-03-20T14:27:35.6724781+00:00</d2p1:CreatedDate>
<d2p1:LastUpdated>2026-03-20T14:27:35.6724781+00:00</d2p1:LastUpdated>
<d2p1:CreatedBy>1</d2p1:CreatedBy>
<d2p1:ModifiedBy>1</d2p1:ModifiedBy>
<d2p1:Actionbuttontext>sample string 27</d2p1:Actionbuttontext>
<d2p1:BeepDeviceOnNewOrderContinuously>true</d2p1:BeepDeviceOnNewOrderContinuously>
<d2p1:BeepDeviceOnNewOrderEnabled>true</d2p1:BeepDeviceOnNewOrderEnabled>
<d2p1:BusinessAddressId>1</d2p1:BusinessAddressId>
<d2p1:CategoryActiveBackground>sample string 32</d2p1:CategoryActiveBackground>
<d2p1:CategoryActiveText>sample string 26</d2p1:CategoryActiveText>
<d2p1:CategoryHoverBackground>sample string 31</d2p1:CategoryHoverBackground>
<d2p1:CategoryHoverText>sample string 30</d2p1:CategoryHoverText>
<d2p1:ChickenToMe>true</d2p1:ChickenToMe>
<d2p1:CollectionEnabled>true</d2p1:CollectionEnabled>
<d2p1:CollectionInterval>2</d2p1:CollectionInterval>
<d2p1:DeliveryDistance>5</d2p1:DeliveryDistance>
<d2p1:DeliveryEnabled>true</d2p1:DeliveryEnabled>
<d2p1:DeliveryInterval>3</d2p1:DeliveryInterval>
<d2p1:DeliveryStartIn>4</d2p1:DeliveryStartIn>
<d2p1:HeaderText>sample string 29</d2p1:HeaderText>
<d2p1:HomePageText>sample string 28</d2p1:HomePageText>
<d2p1:IsDeleted>true</d2p1:IsDeleted>
<d2p1:MessageBackColour>sample string 15</d2p1:MessageBackColour>
<d2p1:MessageForeColour>sample string 14</d2p1:MessageForeColour>
<d2p1:MessageText>sample string 13</d2p1:MessageText>
<d2p1:MinimumDeliveryCost>7</d2p1:MinimumDeliveryCost>
<d2p1:MinimumDeliveryFixed>true</d2p1:MinimumDeliveryFixed>
<d2p1:MinimumDeliveryFixedValue>1</d2p1:MinimumDeliveryFixedValue>
<d2p1:MinimumDeliveryValue>6</d2p1:MinimumDeliveryValue>
<d2p1:Name>sample string 25</d2p1:Name>
<d2p1:NumberOfOrders>1</d2p1:NumberOfOrders>
<d2p1:NumberOfReceipts>1</d2p1:NumberOfReceipts>
<d2p1:OrderNo>1</d2p1:OrderNo>
<d2p1:OrderOnDevice>true</d2p1:OrderOnDevice>
<d2p1:OrderOnPrinter>true</d2p1:OrderOnPrinter>
<d2p1:PreOrderStatus>true</d2p1:PreOrderStatus>
<d2p1:PrintNewOrderReceiptAuto>true</d2p1:PrintNewOrderReceiptAuto>
<d2p1:PrintNewOrderReceiptEnabled>true</d2p1:PrintNewOrderReceiptEnabled>
<d2p1:RightMessageBackColour>sample string 21</d2p1:RightMessageBackColour>
<d2p1:RightMessageForeColour>sample string 20</d2p1:RightMessageForeColour>
<d2p1:RightMessageText>sample string 19</d2p1:RightMessageText>
<d2p1:ScrollbarBackground>sample string 33</d2p1:ScrollbarBackground>
<d2p1:ScrollbarForeground>sample string 34</d2p1:ScrollbarForeground>
<d2p1:SendNewOrderEmailEnabled>true</d2p1:SendNewOrderEmailEnabled>
<d2p1:SendNewOrderSMSEnabled>true</d2p1:SendNewOrderSMSEnabled>
<d2p1:TableEnabled>true</d2p1:TableEnabled>
<d2p1:TableReservationEnabled>true</d2p1:TableReservationEnabled>
<d2p1:Target>sample string 24</d2p1:Target>
<d2p1:URL>sample string 23</d2p1:URL>
<d2p1:allergens>sample string 22</d2p1:allergens>
</d2p1:BaseBusinessAddressSettingModel>
<d2p1:BaseBusinessAddressSettingModel>
<d2p1:Id>1</d2p1:Id>
<d2p1:CreatedDate>2026-03-20T14:27:35.6724781+00:00</d2p1:CreatedDate>
<d2p1:LastUpdated>2026-03-20T14:27:35.6724781+00:00</d2p1:LastUpdated>
<d2p1:CreatedBy>1</d2p1:CreatedBy>
<d2p1:ModifiedBy>1</d2p1:ModifiedBy>
<d2p1:Actionbuttontext>sample string 27</d2p1:Actionbuttontext>
<d2p1:BeepDeviceOnNewOrderContinuously>true</d2p1:BeepDeviceOnNewOrderContinuously>
<d2p1:BeepDeviceOnNewOrderEnabled>true</d2p1:BeepDeviceOnNewOrderEnabled>
<d2p1:BusinessAddressId>1</d2p1:BusinessAddressId>
<d2p1:CategoryActiveBackground>sample string 32</d2p1:CategoryActiveBackground>
<d2p1:CategoryActiveText>sample string 26</d2p1:CategoryActiveText>
<d2p1:CategoryHoverBackground>sample string 31</d2p1:CategoryHoverBackground>
<d2p1:CategoryHoverText>sample string 30</d2p1:CategoryHoverText>
<d2p1:ChickenToMe>true</d2p1:ChickenToMe>
<d2p1:CollectionEnabled>true</d2p1:CollectionEnabled>
<d2p1:CollectionInterval>2</d2p1:CollectionInterval>
<d2p1:DeliveryDistance>5</d2p1:DeliveryDistance>
<d2p1:DeliveryEnabled>true</d2p1:DeliveryEnabled>
<d2p1:DeliveryInterval>3</d2p1:DeliveryInterval>
<d2p1:DeliveryStartIn>4</d2p1:DeliveryStartIn>
<d2p1:HeaderText>sample string 29</d2p1:HeaderText>
<d2p1:HomePageText>sample string 28</d2p1:HomePageText>
<d2p1:IsDeleted>true</d2p1:IsDeleted>
<d2p1:MessageBackColour>sample string 15</d2p1:MessageBackColour>
<d2p1:MessageForeColour>sample string 14</d2p1:MessageForeColour>
<d2p1:MessageText>sample string 13</d2p1:MessageText>
<d2p1:MinimumDeliveryCost>7</d2p1:MinimumDeliveryCost>
<d2p1:MinimumDeliveryFixed>true</d2p1:MinimumDeliveryFixed>
<d2p1:MinimumDeliveryFixedValue>1</d2p1:MinimumDeliveryFixedValue>
<d2p1:MinimumDeliveryValue>6</d2p1:MinimumDeliveryValue>
<d2p1:Name>sample string 25</d2p1:Name>
<d2p1:NumberOfOrders>1</d2p1:NumberOfOrders>
<d2p1:NumberOfReceipts>1</d2p1:NumberOfReceipts>
<d2p1:OrderNo>1</d2p1:OrderNo>
<d2p1:OrderOnDevice>true</d2p1:OrderOnDevice>
<d2p1:OrderOnPrinter>true</d2p1:OrderOnPrinter>
<d2p1:PreOrderStatus>true</d2p1:PreOrderStatus>
<d2p1:PrintNewOrderReceiptAuto>true</d2p1:PrintNewOrderReceiptAuto>
<d2p1:PrintNewOrderReceiptEnabled>true</d2p1:PrintNewOrderReceiptEnabled>
<d2p1:RightMessageBackColour>sample string 21</d2p1:RightMessageBackColour>
<d2p1:RightMessageForeColour>sample string 20</d2p1:RightMessageForeColour>
<d2p1:RightMessageText>sample string 19</d2p1:RightMessageText>
<d2p1:ScrollbarBackground>sample string 33</d2p1:ScrollbarBackground>
<d2p1:ScrollbarForeground>sample string 34</d2p1:ScrollbarForeground>
<d2p1:SendNewOrderEmailEnabled>true</d2p1:SendNewOrderEmailEnabled>
<d2p1:SendNewOrderSMSEnabled>true</d2p1:SendNewOrderSMSEnabled>
<d2p1:TableEnabled>true</d2p1:TableEnabled>
<d2p1:TableReservationEnabled>true</d2p1:TableReservationEnabled>
<d2p1:Target>sample string 24</d2p1:Target>
<d2p1:URL>sample string 23</d2p1:URL>
<d2p1:allergens>sample string 22</d2p1:allergens>
</d2p1:BaseBusinessAddressSettingModel>
</BaseObjects>
<Message>sample string 2</Message>
<Status>true</Status>
<Token>23e8c735-9954-423a-bb9c-a87697b27ce3</Token>
</GetBaseBusinessAddressSettingsResponse>