developers
esc

Popular

↑ ↓ navigate↵ openAgents: llms.txt

Core APIOutlets

Get outlet details

gethttps://core-api.ancon.io/api/v1.1/Outlets/{outletId}
View .mdOpenAPI

Authorization

  • Access-Tokenheaderrequired

    Tenant- or outlet-level token from the backoffice. See Get started.

Path parameters

  • outletIdstring (uuid)required

Header parameters

  • correlationIdstring

    Correlation Id for the request

Responses

200OKapplication/json
  • outletobject | null
    18 fields in outlet
    • idstring (uuid)
    • tenantIdstring (uuid)
    • namestring | null
    • businessNumberstring | null
    • timeZoneOffsetstring (date-span)
    • openingHoursarray<object> | null
      11 fields in openingHours
      • typeinteger (int32)

        Allowed values: 0, 1.

      • orderFormatinteger (int32)

        Allowed values: 0, 1, 2, 4, 8, 16, 32, 64, 128, 159, 191.

      • stateinteger (int32)

        Allowed values: 0, 1.

      • dayOfWeekinteger (int32)

        Allowed values: 0, 1, 2, 4, 8, 16, 31, 32, 64, 96, 127.

      • periodFromstring (date-time)
      • periodTostring (date-time)
      • fromstring (time)
      • durationstring (date-span)
      • reasonstring | null
      • isDefaultboolean
      • positioninteger (int32)
    • deliveryAreaobject | null
      1 field in deliveryArea
      • locationsarray<object> | null
        2 fields in locations
        • latitudenumber (double)
        • longitudenumber (double)
    • blockedVisibilitiesinteger (int32)

      Allowed values: 0, 1, 2.

    • verificationSeriesstring | null
    • voucherTrackingobject | null
      2 fields in voucherTracking
      • costCenterstring | null
      • projectstring | null
    • tipobject | null
      2 fields in tip
      • showTipAsinteger (int32)

        Allowed values: 0, 1.

      • reduceAmountOninteger (int32)

        Allowed values: 0, 1.

    • autoOrderVoucherBasisTimestring (time)
    • generateAutoOrderVoucherBasisboolean
    • smsSenderIdstring | null
    • autoAcceptOrderModeinteger (int32)

      Allowed values: 0, 1, 2.

    • supportedOrderFormatsinteger (int32)

      Allowed values: 0, 1, 2, 4, 8, 16, 32, 64, 128, 159, 191.

    • orderFormatSettingsarray<object> | null
      5 fields in orderFormatSettings
      • orderFormatinteger (int32)

        Allowed values: 0, 1, 2, 4, 8, 16, 32, 64, 128, 159, 191.

      • preparationTimestring (date-span)
      • optionsinteger (int32)

        Allowed values: 1, 2, 4, 8, 16, 32, 64, 128.

      • minimumOrderobject | null
        2 fields in minimumOrder
        • amountnumber (double)
        • currencystring | null
      • aoTippingPercentagesobject | null
        6 fields in aoTippingPercentages
        • percentage1Enabledboolean
        • percentage1Valueinteger (int32)
        • percentage2Enabledboolean
        • percentage2Valueinteger (int32)
        • percentage3Enabledboolean
        • percentage3Valueinteger (int32)
    • receiptSettingsobject | null
      2 fields in receiptSettings
      • textstring | null
      • logoIdstring (uuid) | null
401Unauthorizedapplication/json
  • messagestring | null
404Not Foundapplication/json
  • messagestring | null
  • errorCodestring (uuid)