GET api/Branch/self-order/branch-info?branchID={branchID}&companyCode={companyCode}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
branchID

globally unique identifier

Required

companyCode

string

Required

Body Parameters

None.

Response Information

Resource Description

APIOrderOnlineResultOfOrderOnline_Branch
NameDescriptionTypeAdditional information
Data

OrderOnline_Branch

None.

Success

boolean

None.

ErrorMessage

string

None.

ErrorType

OrderOnlineAPIErrorType

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "BranchID": "5c4d2a26-8401-4fee-afe6-9e2172b96f7c",
    "BranchCode": "sample string 2",
    "ShowInfoCustomerPayConfig": "sample string 3",
    "ListBanner": [
      {
        "Type": 1,
        "FileResourceID": "65e3bf1b-2d61-457b-b37b-1bfdf14045db",
        "SortOrder": 2,
        "IsTemp": true,
        "Extension": "sample string 4",
        "FileType": 5,
        "FileName": "sample string 6"
      },
      {
        "Type": 1,
        "FileResourceID": "65e3bf1b-2d61-457b-b37b-1bfdf14045db",
        "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 4",
    "Address": "sample string 5",
    "ProvinceOrCity": "sample string 6",
    "District": "sample string 7",
    "WardOrCommune": "sample string 8",
    "Street": "sample string 9",
    "PostalCode": "sample string 10",
    "CompanyName": "sample string 11",
    "CompanyTaxCode": "sample string 12",
    "ShortDescription": "sample string 13",
    "Description": "sample string 14",
    "Inactive": true,
    "LocationID": "sample string 16",
    "Language": "sample string 17",
    "OtherInfo": "sample string 19",
    "PhoneNumber": "sample string 20",
    "Email": "sample string 21",
    "Website": "sample string 22",
    "LogoFileResourceID": "2cd96f8b-db4a-4c40-abcb-9069cc13d254",
    "HasVAT": true,
    "DeviveryAmount": 25.0,
    "TimeOpens": [
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      },
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      }
    ],
    "ListTimeOpen2": [
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      },
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      }
    ],
    "ListTimeOpen3": [
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      },
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      }
    ],
    "ListTimeOpen4": [
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      },
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      }
    ],
    "ListTimeOpen5": [
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      },
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      }
    ],
    "ListTimeOpen6": [
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      },
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      }
    ],
    "ListTimeOpen7": [
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      },
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      }
    ],
    "ListTimeOpen8": [
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      },
      {
        "StartTime": "sample string 1",
        "EndTime": "sample string 2",
        "StartTimeUTC": "2025-07-01T21:18:39.5911499+07:00",
        "StartEndUTC": "2025-07-01T21:18:39.5911499+07:00"
      }
    ],
    "FooterContent": "sample string 26",
    "MinTotalAmount": 27.0,
    "MinTotalAmountPickUp": 28.0,
    "IsRequireEmail": true,
    "ShowDeliveryAmount": true,
    "FreeDeliveryRule": 0,
    "DeliveryAmountFreeShip": 31.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:18:39.5911499+07:00",
        "CreatedBy": "sample string 10",
        "ModifiedDate": "2025-07-01T21:18:39.5911499+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:18:39.5911499+07:00",
        "CreatedBy": "sample string 10",
        "ModifiedDate": "2025-07-01T21:18:39.5911499+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:18:39.5911499+07:00",
        "CreatedBy": "sample string 10",
        "ModifiedDate": "2025-07-01T21:18:39.5911499+07:00",
        "ModifiedBy": "sample string 11",
        "IsGenerate": true,
        "IsSetNullForBranchIdInDeleteObject": true
      }
    ],
    "RestaurantBookingType": 0,
    "FanPageID": "sample string 32",
    "NotificationOrderSusscess": "sample string 33",
    "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 34",
    "IsAllowScanMultiTable": true,
    "DeliveryAmountType": 0,
    "PostalFreeDeliveryRule": 0,
    "PostalDeliveryFreeShipAmount": 36.0,
    "StoppingNotificationContent": "sample string 37",
    "Cards": [
      null,
      {
        "CardID": "6c6060a8-4e81-4708-ab82-34861ed9379a",
        "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": "c1f5c62d-8bd2-4f96-a7f0-4a3cc429ea08",
        "FileName": "sample string 11",
        "Extension": "sample string 12",
        "BranchID": "0532c6ae-d091-48b7-8868-6cffe9e4861c",
        "FileType": 16,
        "EditMode": 0,
        "CreatedDate": "2025-07-01T21:18:39.6068043+07:00",
        "CreatedBy": "sample string 14",
        "ModifiedDate": "2025-07-01T21:18:39.6068043+07:00",
        "ModifiedBy": "sample string 15",
        "IsGenerate": true,
        "IsSetNullForBranchIdInDeleteObject": true
      }
    ],
    "BankAccounts": [
      null,
      {
        "BankAccountID": "f1ecfa74-1b88-4a1d-b0cf-6c7c95cbcc45",
        "BankAccountNumber": "sample string 2",
        "Address": "sample string 3",
        "BankID": "c691aeac-1106-4cd3-9fcc-e122dbf90d84",
        "BankCode": "sample string 4",
        "BankName": "sample string 5",
        "BranchID": "b25b9989-b1d3-4041-8196-3915d9584003",
        "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:18:39.6068043+07:00",
        "CreatedBy": "sample string 17",
        "ModifiedDate": "2025-07-01T21:18:39.6068043+07:00",
        "ModifiedBy": "sample string 18",
        "IsGenerate": true,
        "IsSetNullForBranchIdInDeleteObject": true
      }
    ],
    "ColorCode": "sample string 38",
    "DateBranch": "2025-07-01T21:18:39.6068043+07:00",
    "IsUsePayPal": true,
    "IsUseQRIS": true,
    "OpenTimeSaleDishs": [
      null,
      {
        "OpenTimeSaleDishID": "5e23d3bc-abfd-4a78-a0ea-0ff3885ddc2e",
        "OpenTimeSaleDishName": "sample string 2",
        "OpenTimeSaleDishs": "sample string 3",
        "OpenTimeSaleDishType": 1,
        "BranchID": "de3af1d9-4d3d-4bc8-b130-c3d1cb1ce622",
        "EditMode": 0,
        "CreatedDate": "2025-07-01T21:18:39.6068043+07:00",
        "CreatedBy": "sample string 6",
        "ModifiedDate": "2025-07-01T21:18:39.6068043+07:00",
        "ModifiedBy": "sample string 7",
        "IsGenerate": true,
        "IsSetNullForBranchIdInDeleteObject": true
      }
    ],
    "RestaurantName": "sample string 42",
    "RestaurantTel": "sample string 43",
    "LicenseCode": "sample string 44",
    "TaxForGratuity": "sample string 45",
    "SymbolCurrency": "sample string 46",
    "GeneralGroupSeparator": "sample string 47",
    "GeneralDecimalSeparator": "sample string 48",
    "AmountDecimalDigits": 49,
    "CoefficientDecimalDigits": 50,
    "NumberDecimalDigits": 51,
    "QuantityDecimalDigits": 52,
    "QuantityInventoryItemDecimalDigits": 53,
    "UnitPriceDecimalDigits": 54,
    "InventoryItemUnitPriceIncludedVAT": true,
    "VATRate": 66.0,
    "IsPublish5Food": true,
    "VATForDelivery": true,
    "VATForTakeAway": true,
    "VATForShip": true,
    "HasCalcService": true,
    "HasCalcServiceWhenRequire": true,
    "HasServiceRate": true,
    "CalTaxForService": true,
    "CalcServiceDelivery": true,
    "CalcServiceTakeAway": true,
    "IsCalcServiceAmountNotPromotion": true,
    "ServiceRate": 78.0,
    "HasAmountService": true,
    "AmountService": 80.0,
    "IsUseMomo": true,
    "IsUseVNPay": true,
    "IsUseIPay88": true,
    "WalletIpay88s": [
      {
        "CardID": "6c6060a8-4e81-4708-ab82-34861ed9379a",
        "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": "c1f5c62d-8bd2-4f96-a7f0-4a3cc429ea08",
        "FileName": "sample string 11",
        "Extension": "sample string 12",
        "BranchID": "0532c6ae-d091-48b7-8868-6cffe9e4861c",
        "FileType": 16,
        "EditMode": 0,
        "CreatedDate": "2025-07-01T21:18:39.6068043+07:00",
        "CreatedBy": "sample string 14",
        "ModifiedDate": "2025-07-01T21:18:39.6068043+07:00",
        "ModifiedBy": "sample string 15",
        "IsGenerate": true,
        "IsSetNullForBranchIdInDeleteObject": true
      },
      {
        "CardID": "6c6060a8-4e81-4708-ab82-34861ed9379a",
        "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": "c1f5c62d-8bd2-4f96-a7f0-4a3cc429ea08",
        "FileName": "sample string 11",
        "Extension": "sample string 12",
        "BranchID": "0532c6ae-d091-48b7-8868-6cffe9e4861c",
        "FileType": 16,
        "EditMode": 0,
        "CreatedDate": "2025-07-01T21:18:39.6068043+07:00",
        "CreatedBy": "sample string 14",
        "ModifiedDate": "2025-07-01T21:18:39.6068043+07:00",
        "ModifiedBy": "sample string 15",
        "IsGenerate": true,
        "IsSetNullForBranchIdInDeleteObject": true
      }
    ],
    "MainCurrency": "sample string 85",
    "PositionCurrency": 86,
    "ListPaymentType": [
      1,
      2
    ],
    "CalcTaxBeforePromotion": true,
    "TaxForInventoryItem": true,
    "TaxForService": 89.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.