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_BranchSettingName | 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", "Status": true }, "BranchID": "6527fd8a-ae3a-49cb-a275-ce22854ca04d" }, "RestaurantSetting": { "Appearance": { "ListLogoUpload": [ { "Type": 1, "SortOrder": 2, "FileResourceID": "68528246-c917-4ee6-8fed-99ab98a5b80f", "IsTemp": true, "Extension": "sample string 5", "FileType": 0, "FileName": "sample string 6" }, { "Type": 1, "SortOrder": 2, "FileResourceID": "68528246-c917-4ee6-8fed-99ab98a5b80f", "IsTemp": true, "Extension": "sample string 5", "FileType": 0, "FileName": "sample string 6" } ], "FileResourceID": "bb23aab1-2279-430b-91e4-4dfb1375ae1a", "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": "1d70fdc4-377a-4e19-ab4c-a3e7cf849489" }, "QRGeneralSetting": { "PublishOnline": true, "BranchID": "c0435426-c884-4894-94ec-2633c9eda27c" }, "QRMapObjectSetting": "sample string 1", "QROrderingSetting": { "Appearance": { "ListLogoUpload": [ { "Type": 1, "SortOrder": 2, "FileResourceID": "68528246-c917-4ee6-8fed-99ab98a5b80f", "IsTemp": true, "Extension": "sample string 5", "FileType": 0, "FileName": "sample string 6" }, { "Type": 1, "SortOrder": 2, "FileResourceID": "68528246-c917-4ee6-8fed-99ab98a5b80f", "IsTemp": true, "Extension": "sample string 5", "FileType": 0, "FileName": "sample string 6" } ], "FileResourceID": "bb23aab1-2279-430b-91e4-4dfb1375ae1a", "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": "1d70fdc4-377a-4e19-ab4c-a3e7cf849489" }, "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": "sample string 7", "ListTax": [ null, { "TaxID": "95d3fb71-a700-4018-8dec-ba157fec2231", "TaxRate": 2.0, "OldTaxRate": 1.0, "TaxRateValue": "sample string 3", "Description": "sample string 4", "BranchID": "330799e4-aeb5-4236-8f73-5ba62dfbe5f9", "IsChangeTaxRate": true, "TaxName": "sample string 7", "IsDefault": true, "InventoryItemApplyTaxID": "3a6564ed-e308-477b-8480-1e8b1c7ee559", "InventoryItemID": "5e398f46-8ce1-4e0b-bd4b-57e4b12c3612", "EditMode": 0, "CreatedDate": "2025-07-01T21:24:40.3489591+07:00", "CreatedBy": "sample string 10", "ModifiedDate": "2025-07-01T21:24:40.3489591+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, "BranchID": "125e5e68-da99-458d-823a-e51cd6d592d1", "BranchCode": "sample string 22", "ShowInfoCustomerPayConfig": "sample string 23", "ListBanner": [ { "Type": 1, "FileResourceID": "332ae1ef-34dc-40ca-afad-9f4cb1a46d99", "SortOrder": 2, "IsTemp": true, "Extension": "sample string 4", "FileType": 5, "FileName": "sample string 6" }, { "Type": 1, "FileResourceID": "332ae1ef-34dc-40ca-afad-9f4cb1a46d99", "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 24", "Address": "sample string 25", "ProvinceOrCity": "sample string 26", "District": "sample string 27", "WardOrCommune": "sample string 28", "Street": "sample string 29", "PostalCode": "sample string 30", "CompanyName": "sample string 31", "CompanyTaxCode": "sample string 32", "ShortDescription": "sample string 33", "Description": "sample string 34", "Inactive": true, "LocationID": "sample string 36", "Language": "sample string 37", "OtherInfo": "sample string 39", "PhoneNumber": "sample string 40", "Email": "sample string 41", "Website": "sample string 42", "LogoFileResourceID": "6f096de3-706f-48dd-88c8-21a0a4a7adae", "HasVAT": true, "DeviveryAmount": 45.0, "TimeOpens": [ { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" }, { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" } ], "ListTimeOpen2": [ { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" }, { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" } ], "ListTimeOpen3": [ { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" }, { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" } ], "ListTimeOpen4": [ { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" }, { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" } ], "ListTimeOpen5": [ { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" }, { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" } ], "ListTimeOpen6": [ { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" }, { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" } ], "ListTimeOpen7": [ { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" }, { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" } ], "ListTimeOpen8": [ { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" }, { "StartTime": "sample string 1", "EndTime": "sample string 2", "StartTimeUTC": "2025-07-01T21:24:40.3489591+07:00", "StartEndUTC": "2025-07-01T21:24:40.3489591+07:00" } ], "FooterContent": "sample string 46", "MinTotalAmount": 47.0, "MinTotalAmountPickUp": 48.0, "IsRequireEmail": true, "ShowDeliveryAmount": true, "FreeDeliveryRule": 0, "DeliveryAmountFreeShip": 51.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": "2025-07-01T21:24:40.3489591+07:00", "CreatedBy": "sample string 10", "ModifiedDate": "2025-07-01T21:24:40.3489591+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": "2025-07-01T21:24:40.3489591+07:00", "CreatedBy": "sample string 10", "ModifiedDate": "2025-07-01T21:24:40.3489591+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": "2025-07-01T21:24:40.3489591+07:00", "CreatedBy": "sample string 10", "ModifiedDate": "2025-07-01T21:24:40.3489591+07:00", "ModifiedBy": "sample string 11", "IsGenerate": true, "IsSetNullForBranchIdInDeleteObject": true } ], "RestaurantBookingType": 0, "FanPageID": "sample string 52", "NotificationOrderSusscess": "sample string 53", "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 54", "IsAllowScanMultiTable": true, "DeliveryAmountType": 0, "PostalFreeDeliveryRule": 0, "PostalDeliveryFreeShipAmount": 56.0, "StoppingNotificationContent": "sample string 57", "Cards": [ null, { "CardID": "0984b78a-958d-4509-abba-d8ad1959fde4", "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": "6b18c7f7-43eb-43f3-8aa5-458b7987fcd5", "FileName": "sample string 11", "Extension": "sample string 12", "BranchID": "4fdd3609-71fd-4845-be33-e87a7604716b", "FileType": 16, "EditMode": 0, "CreatedDate": "2025-07-01T21:24:40.3489591+07:00", "CreatedBy": "sample string 14", "ModifiedDate": "2025-07-01T21:24:40.3489591+07:00", "ModifiedBy": "sample string 15", "IsGenerate": true, "IsSetNullForBranchIdInDeleteObject": true } ], "BankAccounts": [ null, { "BankAccountID": "2e18c8d4-85dc-450d-bb6d-9883f3d4815d", "BankAccountNumber": "sample string 2", "Address": "sample string 3", "BankID": "01e7c627-8828-4ab4-ba62-37e14c4c585e", "BankCode": "sample string 4", "BankName": "sample string 5", "BranchID": "d4dc73cf-f438-4741-a015-8453c8299024", "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": "2025-07-01T21:24:40.3489591+07:00", "CreatedBy": "sample string 17", "ModifiedDate": "2025-07-01T21:24:40.3489591+07:00", "ModifiedBy": "sample string 18", "IsGenerate": true, "IsSetNullForBranchIdInDeleteObject": true } ], "ColorCode": "sample string 58", "DateBranch": "2025-07-01T21:24:40.3489591+07:00", "IsUsePayPal": true, "IsUseQRIS": true, "OpenTimeSaleDishs": [ null, { "OpenTimeSaleDishID": "72a34cb2-addf-4084-b202-0f2e6d4510ad", "OpenTimeSaleDishName": "sample string 2", "OpenTimeSaleDishs": "sample string 3", "OpenTimeSaleDishType": 1, "BranchID": "7a0335fa-a360-4142-b836-b15c8cbf7d2f", "EditMode": 0, "CreatedDate": "2025-07-01T21:24:40.3645832+07:00", "CreatedBy": "sample string 6", "ModifiedDate": "2025-07-01T21:24:40.3645832+07:00", "ModifiedBy": "sample string 7", "IsGenerate": true, "IsSetNullForBranchIdInDeleteObject": true } ], "RestaurantName": "sample string 62", "RestaurantTel": "sample string 63", "LicenseCode": "sample string 64", "TaxForGratuity": "sample string 65", "SymbolCurrency": "sample string 66", "GeneralGroupSeparator": "sample string 67", "GeneralDecimalSeparator": "sample string 68", "AmountDecimalDigits": 69, "CoefficientDecimalDigits": 70, "NumberDecimalDigits": 71, "QuantityDecimalDigits": 72, "QuantityInventoryItemDecimalDigits": 73, "UnitPriceDecimalDigits": 74, "InventoryItemUnitPriceIncludedVAT": true, "VATRate": 86.0, "IsPublish5Food": true, "VATForDelivery": true, "VATForTakeAway": true, "VATForShip": true, "HasCalcService": true, "HasCalcServiceWhenRequire": true, "HasServiceRate": true, "CalTaxForService": true, "CalcServiceDelivery": true, "CalcServiceTakeAway": true, "IsCalcServiceAmountNotPromotion": true, "ServiceRate": 98.0, "HasAmountService": true, "AmountService": 100.0, "IsUseMomo": true, "IsUseVNPay": true, "IsUseIPay88": true, "WalletIpay88s": [ { "CardID": "0984b78a-958d-4509-abba-d8ad1959fde4", "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": "6b18c7f7-43eb-43f3-8aa5-458b7987fcd5", "FileName": "sample string 11", "Extension": "sample string 12", "BranchID": "4fdd3609-71fd-4845-be33-e87a7604716b", "FileType": 16, "EditMode": 0, "CreatedDate": "2025-07-01T21:24:40.3489591+07:00", "CreatedBy": "sample string 14", "ModifiedDate": "2025-07-01T21:24:40.3489591+07:00", "ModifiedBy": "sample string 15", "IsGenerate": true, "IsSetNullForBranchIdInDeleteObject": true }, { "CardID": "0984b78a-958d-4509-abba-d8ad1959fde4", "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": "6b18c7f7-43eb-43f3-8aa5-458b7987fcd5", "FileName": "sample string 11", "Extension": "sample string 12", "BranchID": "4fdd3609-71fd-4845-be33-e87a7604716b", "FileType": 16, "EditMode": 0, "CreatedDate": "2025-07-01T21:24:40.3489591+07:00", "CreatedBy": "sample string 14", "ModifiedDate": "2025-07-01T21:24:40.3489591+07:00", "ModifiedBy": "sample string 15", "IsGenerate": true, "IsSetNullForBranchIdInDeleteObject": true } ], "MainCurrency": "sample string 105", "PositionCurrency": 106, "ListPaymentType": [ 1, 2 ], "CalcTaxBeforePromotion": true, "TaxForInventoryItem": true, "TaxForService": 109.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.