---
title: "Get region by id"
method: GET
path: "/api/v1/partner/regions/{regionId}"
tags: ["Blaze Partner Vendor"]
---

# Get region by id

`GET /api/v1/partner/regions/{regionId}`

## Path parameters

- `regionId` string, required

## Response `200`

successful operation

- BlazeRegion
  - `id` string
  - `created` integer
  - `modified` integer
  - `deleted` boolean
  - `updated` boolean
  - `companyId` string
  - `name` string
  - `active` boolean
  - `latitude` number, double
  - `longitude` number, double
  - `regionDefault` boolean
  - `deliveryFee` number
  - `openAt` string
  - `openAtNumeric` integer
  - `closeAtNumeric` integer
  - `closeAt` string
  - `daysClose` string[]
  - `minOrderAmount` number
  - `freeDeliveryAfter` number
  - `zoneType` 'zipCode' | 'kml'
  - `fileZone` string
  - `taxRuleId` string
  - `deliveryCharge` number
  - `kmlEdges` BlazeKmlEdge[]
    - `active` boolean
    - `coordinates` BlazeKmlCoordinate[]
      - `lat` number, double
      - `lng` number, double
    - `asset` BlazeKmlAsset
      - `id` string
      - `created` integer
      - `modified` integer
      - `deleted` boolean
      - `updated` boolean
      - `companyId` string
      - `key` string
      - `name` string
      - `type` string
      - `secured` boolean
  - `drivers` Employee[]
    - `id` string
    - `created` integer
    - `modified` integer
    - `deleted` boolean
    - `updated` boolean
    - `companyId` string
    - `authUserId` string
    - `firstName` string
    - `lastName` string
    - `pin` string
    - `roleId` string
    - `email` string
    - `password` string
    - `driversLicense` string
    - `occupationLicenseNumber` string
    - `dlExpirationDate` string
    - `vehicleMake` string
    - `notes` Note[]
      - `id` string
      - `created` integer
      - `modified` integer
      - `deleted` boolean
      - `updated` boolean
      - `writerId` string
      - `writerName` string
      - `message` string
      - `enableOnFleet` boolean
    - `shops` string[]
    - `disabled` boolean
    - `phoneNumber` string
    - `assignedInventoryId` string
    - `assignedTerminalId` string
    - `address` Address
      - `id` string
      - `created` integer
      - `modified` integer
      - `deleted` boolean
      - `updated` boolean
      - `companyId` string
      - `address` string
      - `city` string
      - `state` string
      - `zipCode` string
      - `addressLine2` string
      - `country` string
      - `latitude` number
      - `longitude` number
      - `completeTransaction` boolean
    - `terminalName` string
    - `cashDrawerStatus` 'Open' | 'Closed'
    - `inventoryName` string
    - `timecardId` string
    - `timeCard` TimeCard
      - `id` string
      - `created` integer
      - `modified` integer
      - `deleted` boolean
      - `updated` boolean
      - `companyId` string
      - `shopId` string
      - `dirty` boolean
      - `employeeId` string
      - `clockInTime` integer
      - `clockOutTime` integer
      - `clockin` boolean
      - `sessions` EmployeeSession[]
        - `id` string
        - `created` integer
        - `modified` integer
        - `deleted` boolean
        - `updated` boolean
        - `companyId` string
        - `shopId` string
        - `dirty` boolean
        - `terminalId` string
        - `employeeId` string
        - `timeCardId` string
        - `startTime` integer
        - `endTime` integer
    - `role` Role
      - `id` string
      - `created` integer
      - `modified` integer
      - `deleted` boolean
      - `updated` boolean
      - `companyId` string
      - `permissions` string[]
      - `name` string
      - `roleLevel` 'ADMIN' | 'MANAGER' | 'SHOP_MANAGER_AND_DISPATCHER' | 'OTHER' | 'INACTIVE'
    - `canApplyCustomDiscount` boolean
    - `insuranceExpireDate` integer
    - `insuranceCompanyName` string
    - `policyNumber` string
    - `registrationExpireDate` integer
    - `vehiclePin` string
    - `vinNo` string
    - `vehicleModel` string
    - `vehicleLicensePlate` string
    - `tripId` string
    - `recentLocation` TerminalLocation
      - `id` string
      - `created` integer
      - `modified` integer
      - `deleted` boolean
      - `updated` boolean
      - `companyId` string
      - `shopId` string
      - `dirty` boolean
      - `terminalId` string
      - `employeeId` string
      - `timeCardId` string
      - `deviceId` string
      - `name` string
      - `loc` number[]
    - `employeeOnFleetInfoList` EmployeeOnFleetInfo[]
      - `shopId` string
      - `onFleetWorkerId` string
      - `onFleetTeamList` string[]
      - `onFleetWorkerName` string
    - `appAccessList` string[]
    - `tookanInfoList` EmployeeTookanInfo[]
      - `shopId` string
      - `tookanAgentId` string
      - `status` 'AVAILABLE' | 'OFFLINE' | 'BUSY'
      - `teamId` string
    - `lastLoggedInShopId` string
    - `lastLoginTime` integer
    - `driver` boolean
    - `externalId` string
    - `organizationIds` string[]
    - `yellowfinRoleCode` 'NONE' | 'YFADMIN' | 'BASICINSIGHTS' | 'YFCORPWRITER' | 'BASICINSIGHTSDASHBOARDS' | 'BASICINSIGHTSREPORTING' | 'INSIGHTSSTANDARD1' | 'INSIGHTSSTANDARD2' | 'INSIGHTSSTANDARD3' | 'INSIGHTSSTANDARD4' | 'ADVANCEDINSIGHTS1' | 'ADVANCEDINSIGHTS2' | 'ADVANCEDINSIGHTS3' | 'ADVANCEDINSIGHTS4'
    - `defaultVehicleId` string
    - `biotrack` boolean
    - `biotrackTransId` string
    - `biotrackTransIdOriginal` string
    - `birthDate` integer
    - `hireDate` integer
    - `sessionTime` integer
    - `lastPasswordChangedOn` integer
    - `packer` boolean
    - `internal` boolean
    - `importId` string
    - `metrcRetailerDeliveryId` integer
    - `platformUserId` string
    - `platformCognitoId` string
    - `permissions` string[]
    - `isBlazeAdmin` boolean
    - `isSuperAdmin` boolean
    - `name` string
  - `terminals` Terminal[]
    - `id` string
    - `created` integer
    - `modified` integer
    - `deleted` boolean
    - `updated` boolean
    - `companyId` string
    - `shopId` string
    - `dirty` boolean
    - `active` boolean
    - `deviceId` string
    - `name` string
    - `deviceModel` string
    - `deviceVersion` string
    - `deviceName` string
    - `appVersion` string
    - `deviceToken` string
    - `deviceType` string
    - `assignedInventoryId` string
    - `cvAccountId` string
    - `currentEmployeeId` string
    - `terminalType` 'NotAssigned' | 'WalkIn' | 'Delivery' | 'SelfCheckout' | 'Event'
    - `posTerminal` string
    - `regionId` string
    - `creditCardReader` CreditCardReader
      - `encryptionType` 'BlazeSymmetricEncryption' | 'DUKPT'
      - `secretKey` string
    - `onPremEnabled` boolean
    - `assignSafeInventory` boolean
    - `brandIds` string[]
    - `terminalLocations` TerminalLocation[]
      - `id` string
      - `created` integer
      - `modified` integer
      - `deleted` boolean
      - `updated` boolean
      - `companyId` string
      - `shopId` string
      - `dirty` boolean
      - `terminalId` string
      - `employeeId` string
      - `timeCardId` string
      - `deviceId` string
      - `name` string
      - `loc` number[]
    - `checkoutType` 'Direct' | 'Fulfillment' | 'FulfillmentThreeStep'
    - `deviceDetails` DeviceDetail[]
      - `deviceId` string
      - `version` string
      - `deviceToken` string
      - `appType` 'Connect' | 'Blaze' | 'Developer' | 'StoreWidget' | 'Distribution' | 'Grow' | 'Zeus' | 'DeliveryApp' | 'POS'
      - `deviceType` 'Android' | 'iOS' | 'Desktop' | 'Web'
      - `deviceVersion` string
      - `sdkVersion` string
      - `deviceModel` string
      - `deviceName` string
      - `active` boolean
    - `quickStartAmount` number
  - `shopName` string
  - `shopId` string
  - `inventories` Inventory[]
    - `id` string
    - `created` integer
    - `modified` integer
    - `deleted` boolean
    - `updated` boolean
    - `companyId` string
    - `shopId` string
    - `dirty` boolean
    - `type` 'Storage' | 'Field' | 'Quarantine'
    - `name` string
    - `active` boolean
    - `regionIds` string[]
    - `externalId` string
    - `dryRoom` boolean
    - `quantity` number
    - `complianceInvRoomName` string
    - `complianceInvRoomId` integer
    - `roomType` string[]
    - `numTerminals` integer
  - `daysOperation` string[]
  - `zipCodes` string[]
  - `kmlColor` string
  - `inventoryTerminalDriverResult` InventoryTerminalDriverResult[]
    - `item` integer
    - `terminalId` string
    - `terminalName` string
    - `cashDrawerStatus` 'Open' | 'Closed'
    - `inventoryId` string
    - `inventoryName` string
    - `driverId` string
    - `driverFirstName` string
    - `driverLastName` string
  - `allowedConsumerTypes` string[]

---

[API](https://skmtc.dev/blaze/apis/blaze-developer-api.md) · [All operations](https://skmtc.dev/blaze/apis/blaze-developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/blaze/blaze-developer-api/revisions/784b1a029ac6/schema)