GET api/Branch/order-online-us/branch-setting?branchID={branchID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| branchID | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
APIOrderOnlineResultOfOrderOnline_BranchSetting| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | OrderOnline_BranchSetting |
None. |
|
| Success | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| ErrorType | OrderOnlineAPIErrorType |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"GeneralSetting": {
"PublishOnline": true,
"AcceptOrder": true,
"HolidaySettings": {
"ListHoliday": "sample string 1",
"ListHolidayNew": "sample string 2",
"Status": true
},
"BranchID": "f860874a-b10e-4384-8902-d43be452aba6"
},
"RestaurantSetting": {
"Appearance": {
"ListLogoUpload": [
{
"Type": 1,
"SortOrder": 2,
"FileResourceID": "d30c3973-afe1-4822-a433-d8b87ec50f98",
"IsTemp": true,
"Extension": "sample string 5",
"FileType": 0,
"FileName": "sample string 6"
},
{
"Type": 1,
"SortOrder": 2,
"FileResourceID": "d30c3973-afe1-4822-a433-d8b87ec50f98",
"IsTemp": true,
"Extension": "sample string 5",
"FileType": 0,
"FileName": "sample string 6"
}
],
"FileResourceID": "a9219c1d-ba4c-4480-b18a-e7687ad38307",
"IsTemp": true,
"Extension": "sample string 3",
"FileType": 0,
"FileName": "sample string 4"
},
"RestaurantInfo": {
"RestaurantName": "sample string 1",
"PhoneNumber": "sample string 2",
"EmailAddress": "sample string 3",
"AddressLine1": "sample string 4",
"Country": "sample string 5",
"City": "sample string 6",
"State": "sample string 7",
"ZipCode": "sample string 8",
"GoogleMapLink": "sample string 9"
},
"BusinessHour": [
{
"TimeWorking": [
{
"StartTimeInt": 1,
"EndTimeInt": 2,
"StartTime": "sample string 3",
"EndTime": "sample string 4"
},
{
"StartTimeInt": 1,
"EndTimeInt": 2,
"StartTime": "sample string 3",
"EndTime": "sample string 4"
}
],
"DateOfWeek": 1,
"Status": 2
},
{
"TimeWorking": [
{
"StartTimeInt": 1,
"EndTimeInt": 2,
"StartTime": "sample string 3",
"EndTime": "sample string 4"
},
{
"StartTimeInt": 1,
"EndTimeInt": 2,
"StartTime": "sample string 3",
"EndTime": "sample string 4"
}
],
"DateOfWeek": 1,
"Status": 2
}
],
"OrderSettings": {
"RequiredEmail": true,
"TimeFoodPreparation": 2,
"OrderConfirmation": true,
"AutomaticConfirmType": 4,
"AutomaticallyPrintBill": true,
"AutomaticPrintBillType": 6,
"AutomaticallySend": {
"Status": true,
"Type": 2,
"TimeSend": 3
},
"RequestForCutlery": true
},
"PaymentGetway": {
"PayOnPikUp": true,
"CreditCard": true,
"IsConnectAuth": true,
"PaymentInAdvance": true
},
"BranchID": "febbca04-56ee-4c65-9918-a33e43217bf9"
},
"QRGeneralSetting": {
"PublishOnline": true,
"BranchID": "cad4467a-ce7d-4aa8-8010-8f26e4f1ef99"
},
"QRMapObjectSetting": "sample string 1",
"QROrderingSetting": {
"Appearance": {
"ListLogoUpload": [
{
"Type": 1,
"SortOrder": 2,
"FileResourceID": "d30c3973-afe1-4822-a433-d8b87ec50f98",
"IsTemp": true,
"Extension": "sample string 5",
"FileType": 0,
"FileName": "sample string 6"
},
{
"Type": 1,
"SortOrder": 2,
"FileResourceID": "d30c3973-afe1-4822-a433-d8b87ec50f98",
"IsTemp": true,
"Extension": "sample string 5",
"FileType": 0,
"FileName": "sample string 6"
}
],
"FileResourceID": "a9219c1d-ba4c-4480-b18a-e7687ad38307",
"IsTemp": true,
"Extension": "sample string 3",
"FileType": 0,
"FileName": "sample string 4"
},
"RestaurantInfo": {
"RestaurantName": "sample string 1",
"PhoneNumber": "sample string 2",
"EmailAddress": "sample string 3",
"AddressLine1": "sample string 4",
"Country": "sample string 5",
"City": "sample string 6",
"State": "sample string 7",
"ZipCode": "sample string 8",
"GoogleMapLink": "sample string 9"
},
"BusinessHour": [
{
"TimeWorking": [
{
"StartTimeInt": 1,
"EndTimeInt": 2,
"StartTime": "sample string 3",
"EndTime": "sample string 4"
},
{
"StartTimeInt": 1,
"EndTimeInt": 2,
"StartTime": "sample string 3",
"EndTime": "sample string 4"
}
],
"DateOfWeek": 1,
"Status": 2
},
{
"TimeWorking": [
{
"StartTimeInt": 1,
"EndTimeInt": 2,
"StartTime": "sample string 3",
"EndTime": "sample string 4"
},
{
"StartTimeInt": 1,
"EndTimeInt": 2,
"StartTime": "sample string 3",
"EndTime": "sample string 4"
}
],
"DateOfWeek": 1,
"Status": 2
}
],
"OrderSettings": {
"RequiredEmail": true,
"TimeFoodPreparation": 2,
"OrderConfirmation": true,
"AutomaticConfirmType": 4,
"AutomaticallyPrintBill": true,
"AutomaticPrintBillType": 6,
"AutomaticallySend": {
"Status": true,
"Type": 2,
"TimeSend": 3
},
"RequestForCutlery": true
},
"PaymentGetway": {
"PayOnPikUp": true,
"CreditCard": true,
"IsConnectAuth": true,
"PaymentInAdvance": true
},
"BranchID": "febbca04-56ee-4c65-9918-a33e43217bf9"
},
"ShowTipSuggest": true,
"TipSuggestValue": [
{
"Amount": 1,
"Inactive": 2,
"SortOrder": 3
},
{
"Amount": 1,
"Inactive": 2,
"SortOrder": 3
}
],
"IsTipSuggestIncludeTax": true,
"IsTipSuggestIncludeServiceCharge": true,
"ServiceChargeUS": "sample string 5",
"FormatDateOption": "sample string 6",
"FormatTimeOption": 7,
"ListTax": [
null,
{
"TaxID": "4451b98e-be9d-4c03-9919-beae4fd4ef14",
"TaxRate": 2.0,
"OldTaxRate": 1.0,
"TaxRateValue": "sample string 3",
"Description": "sample string 4",
"BranchID": "0022590e-02cc-4f92-8ae6-c178d449b4e2",
"IsChangeTaxRate": true,
"TaxName": "sample string 7",
"IsDefault": true,
"InventoryItemApplyTaxID": "366a29c3-47c3-4fcf-b5ad-7fe4f838c91e",
"InventoryItemID": "3059b1b9-8845-4401-b433-350bf71f389b",
"EditMode": 0,
"CreatedDate": "2026-05-11T18:21:22.0212759+07:00",
"CreatedBy": "sample string 10",
"ModifiedDate": "2026-05-11T18:21:22.0212759+07:00",
"ModifiedBy": "sample string 11",
"IsGenerate": true,
"IsSetNullForBranchIdInDeleteObject": true
}
],
"HasNonCashAdjustment": true,
"NonCashAdjustmentApplyType": 9,
"NonCashAdjustmentRate": 10.0,
"NonCashAdjustmentAmount": 11.0,
"NonCashName": "sample string 12",
"NumberPeopleToGratuity": 1,
"AutoApplyGratuityPercentage": 1.0,
"ApplyGratuityFormula": 1,
"ProductPackCode": "sample string 13",
"PriceOnMenu": 14,
"LoyalProgramActivationStatus": 15,
"LoyalProgramActivationDetail": "sample string 16",
"IsEnableLoyaltyAlert": true,
"TyroLocationID": "sample string 18",
"TyroIsConnected": true,
"TyroDevMode": true,
"PointRedemptionMethod": 21,
"RedeemUsingCondition": 22,
"GoogleMerchantName": "sample string 23",
"GoogleMerchantID": "sample string 24",
"Country": "sample string 25",
"BranchID": "2a1c8a3f-a251-4098-aeb0-b3a9bbd9223b",
"BranchCode": "sample string 27",
"ShowInfoCustomerPayConfig": "sample string 28",
"ListBanner": [
{
"Type": 1,
"FileResourceID": "e7615c3c-0535-44bc-9d05-caffbfefffb3",
"SortOrder": 2,
"IsTemp": true,
"Extension": "sample string 4",
"FileType": 5,
"FileName": "sample string 6"
},
{
"Type": 1,
"FileResourceID": "e7615c3c-0535-44bc-9d05-caffbfefffb3",
"SortOrder": 2,
"IsTemp": true,
"Extension": "sample string 4",
"FileType": 5,
"FileName": "sample string 6"
}
],
"SocialNetwork": [
{
"Type": 1,
"Inactive": true,
"Value": "sample string 2"
},
{
"Type": 1,
"Inactive": true,
"Value": "sample string 2"
}
],
"BranchName": "sample string 29",
"Address": "sample string 30",
"ProvinceOrCity": "sample string 31",
"District": "sample string 32",
"WardOrCommune": "sample string 33",
"Street": "sample string 34",
"PostalCode": "sample string 35",
"CompanyName": "sample string 36",
"CompanyTaxCode": "sample string 37",
"ShortDescription": "sample string 38",
"Description": "sample string 39",
"Inactive": true,
"LocationID": "sample string 41",
"Language": "sample string 42",
"OtherInfo": "sample string 44",
"PhoneNumber": "sample string 45",
"Email": "sample string 46",
"Website": "sample string 47",
"LogoFileResourceID": "fa9c400d-0c5f-401e-9b1e-aec0bdcc515f",
"HasVAT": true,
"DeviveryAmount": 50.0,
"TimeOpens": [
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
},
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
}
],
"ListTimeOpen2": [
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
},
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
}
],
"ListTimeOpen3": [
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
},
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
}
],
"ListTimeOpen4": [
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
},
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
}
],
"ListTimeOpen5": [
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
},
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
}
],
"ListTimeOpen6": [
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
},
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
}
],
"ListTimeOpen7": [
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
},
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
}
],
"ListTimeOpen8": [
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
},
{
"StartTime": "sample string 1",
"EndTime": "sample string 2",
"StartTimeUTC": "2026-05-11T18:21:22.0212759+07:00",
"StartEndUTC": "2026-05-11T18:21:22.0212759+07:00"
}
],
"FooterContent": "sample string 51",
"MinTotalAmount": 52.0,
"MinTotalAmountPickUp": 53.0,
"IsRequireEmail": true,
"ShowDeliveryAmount": true,
"FreeDeliveryRule": 0,
"DeliveryAmountFreeShip": 56.0,
"ListProvinceOrCitySupport": [
null,
{
"LocationID": "sample string 1",
"Kind": 2,
"AreaCode": "sample string 3",
"LocationName": "sample string 4",
"PostalCode": "sample string 5",
"LocationCode": "sample string 6",
"ZIPCode": "sample string 7",
"SortOrder": 1,
"UsedCount": 1,
"CountryCode": "sample string 8",
"EditMode": 0,
"CreatedDate": "2026-05-11T18:21:22.0212759+07:00",
"CreatedBy": "sample string 10",
"ModifiedDate": "2026-05-11T18:21:22.0212759+07:00",
"ModifiedBy": "sample string 11",
"IsGenerate": true,
"IsSetNullForBranchIdInDeleteObject": true
}
],
"ListDistrictSupport": [
{
"LocationID": "sample string 1",
"Kind": 2,
"AreaCode": "sample string 3",
"LocationName": "sample string 4",
"PostalCode": "sample string 5",
"LocationCode": "sample string 6",
"ZIPCode": "sample string 7",
"SortOrder": 1,
"UsedCount": 1,
"CountryCode": "sample string 8",
"EditMode": 0,
"CreatedDate": "2026-05-11T18:21:22.0212759+07:00",
"CreatedBy": "sample string 10",
"ModifiedDate": "2026-05-11T18:21:22.0212759+07:00",
"ModifiedBy": "sample string 11",
"IsGenerate": true,
"IsSetNullForBranchIdInDeleteObject": true
},
{
"LocationID": "sample string 1",
"Kind": 2,
"AreaCode": "sample string 3",
"LocationName": "sample string 4",
"PostalCode": "sample string 5",
"LocationCode": "sample string 6",
"ZIPCode": "sample string 7",
"SortOrder": 1,
"UsedCount": 1,
"CountryCode": "sample string 8",
"EditMode": 0,
"CreatedDate": "2026-05-11T18:21:22.0212759+07:00",
"CreatedBy": "sample string 10",
"ModifiedDate": "2026-05-11T18:21:22.0212759+07:00",
"ModifiedBy": "sample string 11",
"IsGenerate": true,
"IsSetNullForBranchIdInDeleteObject": true
}
],
"RestaurantBookingType": 0,
"FanPageID": "sample string 57",
"NotificationOrderSusscess": "sample string 58",
"TimeOpenType": 1,
"TimeOpenOption": 1,
"ListDeliveryType": [
1,
2
],
"PostalDeliveryAmounts": [
{
"PostalCode": "sample string 1",
"DeliveryAmount": 2.0
},
{
"PostalCode": "sample string 1",
"DeliveryAmount": 2.0
}
],
"Notification": "sample string 59",
"IsAllowScanMultiTable": true,
"DeliveryAmountType": 0,
"PostalFreeDeliveryRule": 0,
"PostalDeliveryFreeShipAmount": 61.0,
"StoppingNotificationContent": "sample string 62",
"Cards": [
null,
{
"CardID": "ceb960da-97d5-460a-b4b8-f92fdebb18a4",
"CardName": "sample string 2",
"Description": "sample string 3",
"SortOrder": 4,
"SortOrderDisplay": 1,
"Inactive": true,
"CardType": 6,
"IsSystem": true,
"Icon": 8,
"EditVersion": "QEA=",
"WalletCode": 9,
"WalletName": "sample string 10",
"FileResourceID": "624fe56a-d4d0-4c82-8b48-2aa87aa7d707",
"FileName": "sample string 11",
"Extension": "sample string 12",
"BranchID": "ddbcc97a-5a94-4a40-8ba1-a27e5feee8b5",
"FileType": 16,
"EditMode": 0,
"CreatedDate": "2026-05-11T18:21:22.0212759+07:00",
"CreatedBy": "sample string 14",
"ModifiedDate": "2026-05-11T18:21:22.0212759+07:00",
"ModifiedBy": "sample string 15",
"IsGenerate": true,
"IsSetNullForBranchIdInDeleteObject": true
}
],
"BankAccounts": [
null,
{
"BankAccountID": "be6fe790-c85a-4d01-86bc-15db0be3f69a",
"BankAccountNumber": "sample string 2",
"Address": "sample string 3",
"BankID": "00e61d54-ea27-4df6-b454-35263866e821",
"BankCode": "sample string 4",
"BankName": "sample string 5",
"BranchID": "bd5cb859-3ffc-465f-96d3-fff0903b22d8",
"Inactive": true,
"AccountHolder": "sample string 8",
"Description": "sample string 9",
"ProvinceOrCity": "sample string 10",
"EditVersion": "QEA=",
"IsDefault": true,
"SortOrder": 12,
"SortOrderDisplay": 1,
"BankCodeWithNumber": "sample string 5 - sample string 2",
"IsChecked": true,
"Content": "sample string 14",
"Note": "sample string 15",
"EditMode": 0,
"CreatedDate": "2026-05-11T18:21:22.0212759+07:00",
"CreatedBy": "sample string 17",
"ModifiedDate": "2026-05-11T18:21:22.0212759+07:00",
"ModifiedBy": "sample string 18",
"IsGenerate": true,
"IsSetNullForBranchIdInDeleteObject": true
}
],
"ColorCode": "sample string 63",
"DateBranch": "2026-05-11T18:21:22.0212759+07:00",
"IsUsePayPal": true,
"IsUseQRIS": true,
"OpenTimeSaleDishs": [
null,
{
"OpenTimeSaleDishID": "98c32778-b5c9-4090-9fff-af5d2717c946",
"OpenTimeSaleDishName": "sample string 2",
"OpenTimeSaleDishs": "sample string 3",
"OpenTimeSaleDishType": 1,
"BranchID": "cef82ef0-fa3b-4581-a9be-8c39e6d78ea0",
"EditMode": 0,
"CreatedDate": "2026-05-11T18:21:22.0212759+07:00",
"CreatedBy": "sample string 6",
"ModifiedDate": "2026-05-11T18:21:22.0212759+07:00",
"ModifiedBy": "sample string 7",
"IsGenerate": true,
"IsSetNullForBranchIdInDeleteObject": true
}
],
"RestaurantName": "sample string 67",
"RestaurantTel": "sample string 68",
"LicenseCode": "sample string 69",
"TaxForGratuity": "sample string 70",
"ABN": "sample string 71",
"TyroIntegrationStrategy": 72,
"SymbolCurrency": "sample string 73",
"GeneralGroupSeparator": "sample string 74",
"GeneralDecimalSeparator": "sample string 75",
"AmountDecimalDigits": 76,
"CoefficientDecimalDigits": 77,
"NumberDecimalDigits": 78,
"QuantityDecimalDigits": 79,
"QuantityInventoryItemDecimalDigits": 80,
"UnitPriceDecimalDigits": 81,
"InventoryItemUnitPriceIncludedVAT": true,
"VATRate": 93.0,
"IsPublish5Food": true,
"VATForDelivery": true,
"VATForTakeAway": true,
"VATForShip": true,
"HasCalcService": true,
"HasCalcServiceWhenRequire": true,
"HasServiceRate": true,
"CalTaxForService": true,
"CalcServiceDelivery": true,
"CalcServiceTakeAway": true,
"IsCalcServiceAmountNotPromotion": true,
"ServiceRate": 105.0,
"HasAmountService": true,
"AmountService": 107.0,
"IsUseMomo": true,
"IsUseVNPay": true,
"IsUseIPay88": true,
"WalletIpay88s": [
{
"CardID": "ceb960da-97d5-460a-b4b8-f92fdebb18a4",
"CardName": "sample string 2",
"Description": "sample string 3",
"SortOrder": 4,
"SortOrderDisplay": 1,
"Inactive": true,
"CardType": 6,
"IsSystem": true,
"Icon": 8,
"EditVersion": "QEA=",
"WalletCode": 9,
"WalletName": "sample string 10",
"FileResourceID": "624fe56a-d4d0-4c82-8b48-2aa87aa7d707",
"FileName": "sample string 11",
"Extension": "sample string 12",
"BranchID": "ddbcc97a-5a94-4a40-8ba1-a27e5feee8b5",
"FileType": 16,
"EditMode": 0,
"CreatedDate": "2026-05-11T18:21:22.0212759+07:00",
"CreatedBy": "sample string 14",
"ModifiedDate": "2026-05-11T18:21:22.0212759+07:00",
"ModifiedBy": "sample string 15",
"IsGenerate": true,
"IsSetNullForBranchIdInDeleteObject": true
},
{
"CardID": "ceb960da-97d5-460a-b4b8-f92fdebb18a4",
"CardName": "sample string 2",
"Description": "sample string 3",
"SortOrder": 4,
"SortOrderDisplay": 1,
"Inactive": true,
"CardType": 6,
"IsSystem": true,
"Icon": 8,
"EditVersion": "QEA=",
"WalletCode": 9,
"WalletName": "sample string 10",
"FileResourceID": "624fe56a-d4d0-4c82-8b48-2aa87aa7d707",
"FileName": "sample string 11",
"Extension": "sample string 12",
"BranchID": "ddbcc97a-5a94-4a40-8ba1-a27e5feee8b5",
"FileType": 16,
"EditMode": 0,
"CreatedDate": "2026-05-11T18:21:22.0212759+07:00",
"CreatedBy": "sample string 14",
"ModifiedDate": "2026-05-11T18:21:22.0212759+07:00",
"ModifiedBy": "sample string 15",
"IsGenerate": true,
"IsSetNullForBranchIdInDeleteObject": true
}
],
"MainCurrency": "sample string 112",
"PositionCurrency": 113,
"ListPaymentType": [
1,
2
],
"CalcTaxBeforePromotion": true,
"TaxForInventoryItem": true,
"TaxForService": 116.0,
"HasVATRateWhenRequire": true,
"UseMultiPrice": true
},
"Success": true,
"ErrorMessage": "sample string 2",
"ErrorType": 0,
"Total": 3,
"Message": "sample string 4"
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.