SearchResultBlazeRegion resource

Methods

  • get - Search regions

Resource

{
    "limit": "int32",
    "skip": "int32",
    "total": "int64",
    "values": [
        {
            "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
limit int32 Optional
skip int32 Optional
total int64 Optional
values[] array Optional
values[].active boolean Optional
values[].closeAt string Optional
values[].closeAtNumeric int32 Optional
values[].companyId string Optional
values[].created int64 Optional
values[].daysClose[] array of string Optional
values[].daysOperation[] array of string Optional
values[].deleted boolean Optional
values[].deliveryCharge number Optional
values[].deliveryFee number Optional
values[].drivers[] array Optional
values[].drivers[].address object Address Optional
values[].drivers[].address.address string Optional
values[].drivers[].address.addressLine2 string Optional
values[].drivers[].address.city string Optional
values[].drivers[].address.companyId string Optional
values[].drivers[].address.country string Optional
values[].drivers[].address.created int64 Optional
values[].drivers[].address.deleted boolean Optional
values[].drivers[].address.id string Optional
values[].drivers[].address.latitude number Optional
values[].drivers[].address.longitude number Optional
values[].drivers[].address.modified int64 Optional
values[].drivers[].address.state string Optional
values[].drivers[].address.updated boolean Optional
values[].drivers[].address.zipCode string Optional
values[].drivers[].appAccessList[] array of string

Possible values are:

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

Possible values are:

  • Open
  • Closed
 Optional
values[].drivers[].companyId string Optional
values[].drivers[].created int64 Optional
values[].drivers[].deleted boolean Optional
values[].drivers[].disabled boolean Optional
values[].drivers[].dlExpirationDate string Optional
values[].drivers[].driver boolean Optional
values[].drivers[].driversLicense string Optional
values[].drivers[].email string Optional
values[].drivers[].employeeOnFleetInfoList[] array Optional
values[].drivers[].employeeOnFleetInfoList[].onFleetTeamList[] array of string Optional
values[].drivers[].employeeOnFleetInfoList[].onFleetWorkerId string Optional
values[].drivers[].employeeOnFleetInfoList[].shopId string Optional
values[].drivers[].externalId string Optional
values[].drivers[].firstName string Optional
values[].drivers[].id string Optional
values[].drivers[].insuranceCompanyName string Optional
values[].drivers[].insuranceExpireDate int64 Optional
values[].drivers[].inventoryName string Optional
values[].drivers[].lastLoggedInShopId string Optional
values[].drivers[].lastLoginTime int64 Optional
values[].drivers[].lastName string Optional
values[].drivers[].modified int64 Optional
values[].drivers[].notes[] array Optional
values[].drivers[].notes[].created int64 Optional
values[].drivers[].notes[].deleted boolean Optional
values[].drivers[].notes[].enableOnFleet boolean Optional
values[].drivers[].notes[].id string Optional
values[].drivers[].notes[].message string Optional
values[].drivers[].notes[].modified int64 Optional
values[].drivers[].notes[].updated boolean Optional
values[].drivers[].notes[].writerId string Optional
values[].drivers[].notes[].writerName string Optional
values[].drivers[].occupationLicenseNumber string Optional
values[].drivers[].organizationIds[] array of string Optional
values[].drivers[].password string Optional
values[].drivers[].phoneNumber string Optional
values[].drivers[].pin string Optional
values[].drivers[].policyNumber string Optional
values[].drivers[].recentLocation object TerminalLocation Optional
values[].drivers[].recentLocation.companyId string Optional
values[].drivers[].recentLocation.created int64 Optional
values[].drivers[].recentLocation.deleted boolean Optional
values[].drivers[].recentLocation.deviceId string Optional
values[].drivers[].recentLocation.dirty boolean Optional
values[].drivers[].recentLocation.employeeId string Optional
values[].drivers[].recentLocation.id string Optional
values[].drivers[].recentLocation.loc[] array of double Optional
values[].drivers[].recentLocation.modified int64 Optional
values[].drivers[].recentLocation.name string Optional
values[].drivers[].recentLocation.shopId string Optional
values[].drivers[].recentLocation.terminalId string Optional
values[].drivers[].recentLocation.timeCardId string Optional
values[].drivers[].recentLocation.updated boolean Optional
values[].drivers[].registrationExpireDate int64 Optional
values[].drivers[].role object Role Optional
values[].drivers[].role.companyId string Optional
values[].drivers[].role.created int64 Optional
values[].drivers[].role.deleted boolean Optional
values[].drivers[].role.id string Optional
values[].drivers[].role.modified int64 Optional
values[].drivers[].role.name string Optional
values[].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
values[].drivers[].role.updated boolean Optional
values[].drivers[].roleId string Optional
values[].drivers[].shops[] array of string Optional
values[].drivers[].terminalName string Optional
values[].drivers[].timeCard object TimeCard Optional
values[].drivers[].timeCard.clockInTime int64 Optional
values[].drivers[].timeCard.clockOutTime int64 Optional
values[].drivers[].timeCard.clockin boolean Optional
values[].drivers[].timeCard.companyId string Optional
values[].drivers[].timeCard.created int64 Optional
values[].drivers[].timeCard.deleted boolean Optional
values[].drivers[].timeCard.dirty boolean Optional
values[].drivers[].timeCard.employeeId string Optional
values[].drivers[].timeCard.id string Optional
values[].drivers[].timeCard.modified int64 Optional
values[].drivers[].timeCard.sessions[] array Optional
values[].drivers[].timeCard.sessions[].companyId string Optional
values[].drivers[].timeCard.sessions[].created int64 Optional
values[].drivers[].timeCard.sessions[].deleted boolean Optional
values[].drivers[].timeCard.sessions[].dirty boolean Optional
values[].drivers[].timeCard.sessions[].employeeId string Optional
values[].drivers[].timeCard.sessions[].endTime int64 Optional
values[].drivers[].timeCard.sessions[].id string Optional
values[].drivers[].timeCard.sessions[].modified int64 Optional
values[].drivers[].timeCard.sessions[].shopId string Optional
values[].drivers[].timeCard.sessions[].startTime int64 Optional
values[].drivers[].timeCard.sessions[].terminalId string Optional
values[].drivers[].timeCard.sessions[].timeCardId string Optional
values[].drivers[].timeCard.sessions[].updated boolean Optional
values[].drivers[].timeCard.shopId string Optional
values[].drivers[].timeCard.updated boolean Optional
values[].drivers[].timecardId string Optional
values[].drivers[].tookanInfoList[] array Optional
values[].drivers[].tookanInfoList[].shopId string Optional
values[].drivers[].tookanInfoList[].status string

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

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

Possible values are:

  • zipCode
  • kml
 Optional