BlazeRegion resource

Methods

  • get - Get region by id

Resource

{
    "active": "boolean",
    "closeAt": "string",
    "closeAtNumeric": "int32",
    "companyId": "string",
    "created": "int64",
    "daysClose": [
        "string"
    ],
    "daysOperation": [
        "string"
    ],
    "deleted": "boolean",
    "deliveryCharge": "number",
    "deliveryFee": "number",
    "drivers": [
        {
            "address": {
                "address": "string",
                "addressLine2": "string",
                "city": "string",
                "companyId": "string",
                "country": "string",
                "created": "int64",
                "deleted": "boolean",
                "id": "string",
                "latitude": "number",
                "longitude": "number",
                "modified": "int64",
                "state": "string",
                "updated": "boolean",
                "zipCode": "string"
            },
            "appAccessList": [
                "string"
            ],
            "assignedInventoryId": "string",
            "assignedTerminalId": "string",
            "canApplyCustomDiscount": "boolean",
            "cashDrawerStatus": "string",
            "companyId": "string",
            "created": "int64",
            "deleted": "boolean",
            "disabled": "boolean",
            "dlExpirationDate": "string",
            "driver": "boolean",
            "driversLicense": "string",
            "email": "string",
            "employeeOnFleetInfoList": [
                {
                    "onFleetTeamList": [
                        "string"
                    ],
                    "onFleetWorkerId": "string",
                    "shopId": "string"
                }
            ],
            "externalId": "string",
            "firstName": "string",
            "id": "string",
            "insuranceCompanyName": "string",
            "insuranceExpireDate": "int64",
            "inventoryName": "string",
            "lastLoggedInShopId": "string",
            "lastLoginTime": "int64",
            "lastName": "string",
            "modified": "int64",
            "notes": [
                {
                    "created": "int64",
                    "deleted": "boolean",
                    "enableOnFleet": "boolean",
                    "id": "string",
                    "message": "string",
                    "modified": "int64",
                    "updated": "boolean",
                    "writerId": "string",
                    "writerName": "string"
                }
            ],
            "occupationLicenseNumber": "string",
            "organizationIds": [
                "string"
            ],
            "password": "string",
            "phoneNumber": "string",
            "pin": "string",
            "policyNumber": "string",
            "recentLocation": {
                "companyId": "string",
                "created": "int64",
                "deleted": "boolean",
                "deviceId": "string",
                "dirty": "boolean",
                "employeeId": "string",
                "id": "string",
                "loc": [
                    "double"
                ],
                "modified": "int64",
                "name": "string",
                "shopId": "string",
                "terminalId": "string",
                "timeCardId": "string",
                "updated": "boolean"
            },
            "registrationExpireDate": "int64",
            "role": {
                "companyId": "string",
                "created": "int64",
                "deleted": "boolean",
                "id": "string",
                "modified": "int64",
                "name": "string",
                "permissions": [
                    "string"
                ],
                "updated": "boolean"
            },
            "roleId": "string",
            "shops": [
                "string"
            ],
            "terminalName": "string",
            "timeCard": {
                "clockInTime": "int64",
                "clockOutTime": "int64",
                "clockin": "boolean",
                "companyId": "string",
                "created": "int64",
                "deleted": "boolean",
                "dirty": "boolean",
                "employeeId": "string",
                "id": "string",
                "modified": "int64",
                "sessions": [
                    {
                        "companyId": "string",
                        "created": "int64",
                        "deleted": "boolean",
                        "dirty": "boolean",
                        "employeeId": "string",
                        "endTime": "int64",
                        "id": "string",
                        "modified": "int64",
                        "shopId": "string",
                        "startTime": "int64",
                        "terminalId": "string",
                        "timeCardId": "string",
                        "updated": "boolean"
                    }
                ],
                "shopId": "string",
                "updated": "boolean"
            },
            "timecardId": "string",
            "tookanInfoList": [
                {
                    "shopId": "string",
                    "status": "string",
                    "teamId": "string",
                    "tookanAgentId": "string"
                }
            ],
            "updated": "boolean",
            "vehicleLicensePlate": "string",
            "vehicleMake": "string",
            "vehicleModel": "string",
            "vehiclePin": "string",
            "vinNo": "string"
        }
    ],
    "fileZone": "string",
    "freeDeliveryAfter": "number",
    "id": "string",
    "inventories": [
        {
            "active": "boolean",
            "companyId": "string",
            "created": "int64",
            "deleted": "boolean",
            "dirty": "boolean",
            "dryRoom": "boolean",
            "externalId": "string",
            "id": "string",
            "modified": "int64",
            "name": "string",
            "numTerminals": "int32",
            "regionIds": [
                "string"
            ],
            "shopId": "string",
            "type": "string",
            "updated": "boolean"
        }
    ],
    "kmlColor": "string",
    "kmlEdges": [
        {
            "active": "boolean",
            "asset": {
                "companyId": "string",
                "created": "int64",
                "deleted": "boolean",
                "id": "string",
                "key": "string",
                "modified": "int64",
                "name": "string",
                "secured": "boolean",
                "type": "string",
                "updated": "boolean"
            },
            "coordinates": [
                {
                    "lat": "double",
                    "lng": "double"
                }
            ]
        }
    ],
    "latitude": "double",
    "longitude": "double",
    "minOrderAmount": "number",
    "modified": "int64",
    "name": "string",
    "openAt": "string",
    "openAtNumeric": "int32",
    "regionDefault": "boolean",
    "shopId": "string",
    "shopName": "string",
    "taxRuleId": "string",
    "terminals": [
        {
            "active": "boolean",
            "appVersion": "string",
            "assignedInventoryId": "string",
            "checkoutType": "string",
            "companyId": "string",
            "created": "int64",
            "creditCardReader": {
                "encryptionType": "string",
                "secretKey": "string"
            },
            "currentEmployeeId": "string",
            "cvAccountId": "string",
            "deleted": "boolean",
            "deviceDetails": [
                {
                    "active": "boolean",
                    "appType": "string",
                    "deviceId": "string",
                    "deviceModel": "string",
                    "deviceName": "string",
                    "deviceToken": "string",
                    "deviceType": "string",
                    "deviceVersion": "string",
                    "sdkVersion": "string",
                    "version": "string"
                }
            ],
            "deviceId": "string",
            "deviceModel": "string",
            "deviceName": "string",
            "deviceToken": "string",
            "deviceType": "string",
            "deviceVersion": "string",
            "dirty": "boolean",
            "id": "string",
            "modified": "int64",
            "name": "string",
            "onPremEnabled": "boolean",
            "posTerminal": "string",
            "regionId": "string",
            "shopId": "string",
            "terminalLocations": [
                {
                    "companyId": "string",
                    "created": "int64",
                    "deleted": "boolean",
                    "deviceId": "string",
                    "dirty": "boolean",
                    "employeeId": "string",
                    "id": "string",
                    "loc": [
                        "double"
                    ],
                    "modified": "int64",
                    "name": "string",
                    "shopId": "string",
                    "terminalId": "string",
                    "timeCardId": "string",
                    "updated": "boolean"
                }
            ],
            "terminalType": "string",
            "updated": "boolean"
        }
    ],
    "updated": "boolean",
    "zipCodes": [
        "string"
    ],
    "zoneType": "string"
}

Properties

Name Type Description Additional
active boolean Optional
closeAt string Optional
closeAtNumeric int32 Optional
companyId string Optional
created int64 Optional
daysClose[] array of string Optional
daysOperation[] array of string Optional
deleted boolean Optional
deliveryCharge number Optional
deliveryFee number Optional
drivers[] array Optional
drivers[].address object Address Optional
drivers[].address.address string Optional
drivers[].address.addressLine2 string Optional
drivers[].address.city string Optional
drivers[].address.companyId string Optional
drivers[].address.country string Optional
drivers[].address.created int64 Optional
drivers[].address.deleted boolean Optional
drivers[].address.id string Optional
drivers[].address.latitude number Optional
drivers[].address.longitude number Optional
drivers[].address.modified int64 Optional
drivers[].address.state string Optional
drivers[].address.updated boolean Optional
drivers[].address.zipCode string Optional
drivers[].appAccessList[] array of string

Possible values are:

  • AuthenticationApp
  • Retail
  • Distribution
  • Grow
  • Dispatch
 Optional
drivers[].assignedInventoryId string Optional
drivers[].assignedTerminalId string Optional
drivers[].canApplyCustomDiscount boolean Optional
drivers[].cashDrawerStatus string

Possible values are:

  • Open
  • Closed
 Optional
drivers[].companyId string Optional
drivers[].created int64 Optional
drivers[].deleted boolean Optional
drivers[].disabled boolean Optional
drivers[].dlExpirationDate string Optional
drivers[].driver boolean Optional
drivers[].driversLicense string Optional
drivers[].email string Optional
drivers[].employeeOnFleetInfoList[] array Optional
drivers[].employeeOnFleetInfoList[].onFleetTeamList[] array of string Optional
drivers[].employeeOnFleetInfoList[].onFleetWorkerId string Optional
drivers[].employeeOnFleetInfoList[].shopId string Optional
drivers[].externalId string Optional
drivers[].firstName string Optional
drivers[].id string Optional
drivers[].insuranceCompanyName string Optional
drivers[].insuranceExpireDate int64 Optional
drivers[].inventoryName string Optional
drivers[].lastLoggedInShopId string Optional
drivers[].lastLoginTime int64 Optional
drivers[].lastName string Optional
drivers[].modified int64 Optional
drivers[].notes[] array Optional
drivers[].notes[].created int64 Optional
drivers[].notes[].deleted boolean Optional
drivers[].notes[].enableOnFleet boolean Optional
drivers[].notes[].id string Optional
drivers[].notes[].message string Optional
drivers[].notes[].modified int64 Optional
drivers[].notes[].updated boolean Optional
drivers[].notes[].writerId string Optional
drivers[].notes[].writerName string Optional
drivers[].occupationLicenseNumber string Optional
drivers[].organizationIds[] array of string Optional
drivers[].password string Optional
drivers[].phoneNumber string Optional
drivers[].pin string Optional
drivers[].policyNumber string Optional
drivers[].recentLocation object TerminalLocation Optional
drivers[].recentLocation.companyId string Optional
drivers[].recentLocation.created int64 Optional
drivers[].recentLocation.deleted boolean Optional
drivers[].recentLocation.deviceId string Optional
drivers[].recentLocation.dirty boolean Optional
drivers[].recentLocation.employeeId string Optional
drivers[].recentLocation.id string Optional
drivers[].recentLocation.loc[] array of double Optional
drivers[].recentLocation.modified int64 Optional
drivers[].recentLocation.name string Optional
drivers[].recentLocation.shopId string Optional
drivers[].recentLocation.terminalId string Optional
drivers[].recentLocation.timeCardId string Optional
drivers[].recentLocation.updated boolean Optional
drivers[].registrationExpireDate int64 Optional
drivers[].role object Role Optional
drivers[].role.companyId string Optional
drivers[].role.created int64 Optional
drivers[].role.deleted boolean Optional
drivers[].role.id string Optional
drivers[].role.modified int64 Optional
drivers[].role.name string Optional
drivers[].role.permissions[] array of string

Possible values are:

  • None
  • iPadMemberAdd
  • iPadMemberEdit
  • iPadQueueAddMember
  • iPadTransactionsViews
  • iPadProcessSales
  • iPadRefund
  • iPadApplyCartDiscounts
  • iPadApplyLineItemDiscounts
  • iPadApplyCoupons
  • iPadCashDrawerOpen
  • iPadCashDrawerCloseOut
  • iPadTransactionsLookup
  • iPadInitiation
  • iPadQuickPinLogin
  • iPadManageSettingsView
  • iPadManagerSettingsManage
  • WebAdminLogin
  • WebAllMembersView
  • WebMembersView
  • WebMembersManage
  • WebMembersAddToQueue
  • WebPromotionsView
  • WebPromotionsManage
  • WebTransactionsView
  • WebTransactionsRefund
  • WebInventoryView
  • WebInventoryManage
  • WebInventoryTransfer
  • WebInventoryCategoryManage
  • WebEmployeeView
  • WebEmployeeManage
  • WebEmployeeClockout
  • WebVendorView
  • WebVendorManage
  • WebSettingsView
  • WebSettingsManage
  • WebPhysiciansView
  • WebPhysiciansManage
  • WebReportsView
  • WebDeliveryView
  • WebCashDrawerView
  • WebUnlockOrder
  • WebEditBatch
  • WebAddBatch
  • WebInvoiceView
  • WebInvoiceManage
  • WebInventoryReconciliation
  • WebDashboardView
  • WebPurchaseOrderView
  • WebPurchaseOrderManage
  • WebExpenseView
  • WebExpenseManage
  • WebQuickBookManage
  • WebInvoiceManifestChange
  • WebEditPosPayment
  • WebTransactionsVoid
  • WebCancelPosOrders
 Optional
drivers[].role.updated boolean Optional
drivers[].roleId string Optional
drivers[].shops[] array of string Optional
drivers[].terminalName string Optional
drivers[].timeCard object TimeCard Optional
drivers[].timeCard.clockInTime int64 Optional
drivers[].timeCard.clockOutTime int64 Optional
drivers[].timeCard.clockin boolean Optional
drivers[].timeCard.companyId string Optional
drivers[].timeCard.created int64 Optional
drivers[].timeCard.deleted boolean Optional
drivers[].timeCard.dirty boolean Optional
drivers[].timeCard.employeeId string Optional
drivers[].timeCard.id string Optional
drivers[].timeCard.modified int64 Optional
drivers[].timeCard.sessions[] array Optional
drivers[].timeCard.sessions[].companyId string Optional
drivers[].timeCard.sessions[].created int64 Optional
drivers[].timeCard.sessions[].deleted boolean Optional
drivers[].timeCard.sessions[].dirty boolean Optional
drivers[].timeCard.sessions[].employeeId string Optional
drivers[].timeCard.sessions[].endTime int64 Optional
drivers[].timeCard.sessions[].id string Optional
drivers[].timeCard.sessions[].modified int64 Optional
drivers[].timeCard.sessions[].shopId string Optional
drivers[].timeCard.sessions[].startTime int64 Optional
drivers[].timeCard.sessions[].terminalId string Optional
drivers[].timeCard.sessions[].timeCardId string Optional
drivers[].timeCard.sessions[].updated boolean Optional
drivers[].timeCard.shopId string Optional
drivers[].timeCard.updated boolean Optional
drivers[].timecardId string Optional
drivers[].tookanInfoList[] array Optional
drivers[].tookanInfoList[].shopId string Optional
drivers[].tookanInfoList[].status string

Possible values are:

  • AVAILABLE
  • OFFLINE
  • BUSY
 Optional
drivers[].tookanInfoList[].teamId string Optional
drivers[].tookanInfoList[].tookanAgentId string Optional
drivers[].updated boolean Optional
drivers[].vehicleLicensePlate string Optional
drivers[].vehicleMake string Optional
drivers[].vehicleModel string Optional
drivers[].vehiclePin string Optional
drivers[].vinNo string Optional
fileZone string Optional
freeDeliveryAfter number Optional
id string Optional
inventories[] array Optional
inventories[].active boolean Optional
inventories[].companyId string Optional
inventories[].created int64 Optional
inventories[].deleted boolean Optional
inventories[].dirty boolean Optional
inventories[].dryRoom boolean Optional
inventories[].externalId string Optional
inventories[].id string Optional
inventories[].modified int64 Optional
inventories[].name string Optional
inventories[].numTerminals int32 Optional
inventories[].regionIds[] array of string Optional
inventories[].shopId string Optional
inventories[].type string

Possible values are:

  • Storage
  • Field
  • Quarantine
 Optional
inventories[].updated boolean Optional
kmlColor string Optional
kmlEdges[] array Optional
kmlEdges[].active boolean Optional
kmlEdges[].asset object BlazeKmlAsset Optional
kmlEdges[].asset.companyId string Optional
kmlEdges[].asset.created int64 Optional
kmlEdges[].asset.deleted boolean Optional
kmlEdges[].asset.id string Optional
kmlEdges[].asset.key string Optional
kmlEdges[].asset.modified int64 Optional
kmlEdges[].asset.name string Optional
kmlEdges[].asset.secured boolean Optional
kmlEdges[].asset.type string Optional
kmlEdges[].asset.updated boolean Optional
kmlEdges[].coordinates[] array Optional
kmlEdges[].coordinates[].lat double Optional
kmlEdges[].coordinates[].lng double Optional
latitude double Optional
longitude double Optional
minOrderAmount number Optional
modified int64 Optional
name string Optional
openAt string Optional
openAtNumeric int32 Optional
regionDefault boolean Optional
shopId string Optional
shopName string Optional
taxRuleId string Optional
terminals[] array Optional
terminals[].active boolean Optional
terminals[].appVersion string Optional
terminals[].assignedInventoryId string Optional
terminals[].checkoutType string

Possible values are:

  • Direct
  • Fulfillment
  • FulfillmentThreeStep
 Optional
terminals[].companyId string Optional
terminals[].created int64 Optional
terminals[].creditCardReader object CreditCardReader Optional
terminals[].creditCardReader.encryptionType string

Possible values are:

  • BlazeSymmetricEncryption
  • DUKPT
 Optional
terminals[].creditCardReader.secretKey string Optional
terminals[].currentEmployeeId string Optional
terminals[].cvAccountId string Optional
terminals[].deleted boolean Optional
terminals[].deviceDetails[] array Optional
terminals[].deviceDetails[].active boolean Optional
terminals[].deviceDetails[].appType string

Possible values are:

  • Connect
  • Blaze
  • Developer
  • StoreWidget
  • Distribution
  • Grow
  • DeliveryApp
 Optional
terminals[].deviceDetails[].deviceId string Optional
terminals[].deviceDetails[].deviceModel string Optional
terminals[].deviceDetails[].deviceName string Optional
terminals[].deviceDetails[].deviceToken string Optional
terminals[].deviceDetails[].deviceType string

Possible values are:

  • Android
  • iOS
 Optional
terminals[].deviceDetails[].deviceVersion string Optional
terminals[].deviceDetails[].sdkVersion string Optional
terminals[].deviceDetails[].version string Optional
terminals[].deviceId string Optional
terminals[].deviceModel string Optional
terminals[].deviceName string Optional
terminals[].deviceToken string Optional
terminals[].deviceType string Optional
terminals[].deviceVersion string Optional
terminals[].dirty boolean Optional
terminals[].id string Optional
terminals[].modified int64 Optional
terminals[].name string Optional
terminals[].onPremEnabled boolean Optional
terminals[].posTerminal string Optional
terminals[].regionId string Optional
terminals[].shopId string Optional
terminals[].terminalLocations[] array Optional
terminals[].terminalLocations[].companyId string Optional
terminals[].terminalLocations[].created int64 Optional
terminals[].terminalLocations[].deleted boolean Optional
terminals[].terminalLocations[].deviceId string Optional
terminals[].terminalLocations[].dirty boolean Optional
terminals[].terminalLocations[].employeeId string Optional
terminals[].terminalLocations[].id string Optional
terminals[].terminalLocations[].loc[] array of double Optional
terminals[].terminalLocations[].modified int64 Optional
terminals[].terminalLocations[].name string Optional
terminals[].terminalLocations[].shopId string Optional
terminals[].terminalLocations[].terminalId string Optional
terminals[].terminalLocations[].timeCardId string Optional
terminals[].terminalLocations[].updated boolean Optional
terminals[].terminalType string

Possible values are:

  • NotAssigned
  • WalkIn
  • Delivery
  • SelfCheckout
 Optional
terminals[].updated boolean Optional
updated boolean Optional
zipCodes[] array of string Optional
zoneType string

Possible values are:

  • zipCode
  • kml
 Optional