Hold Transaction
Request
POST http:///api/v1/partner/transactions/{transactionId}/hold
Path parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| transactionId | string | Required |
Request body
The request body takes a complete Transaction resource, containing the following writable properties:
{
"active": "boolean",
"addressUpdate": "boolean",
"assets": [
{
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
],
"assigned": "boolean",
"assignedEmployee": {
"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"
},
"assignedEmployeeId": "string",
"autoAccepted": "boolean",
"balance": "number",
"blazeCashBack": "number",
"blazeFee": "number",
"blazeTip": "number",
"blazeTotalCharged": "number",
"cart": {
"adjustmentAmount": "number",
"adjustmentInfoList": [
{
"adjustmentId": "string",
"amount": "number",
"negative": "boolean"
}
],
"afterTaxDiscount": "number",
"afterTaxDiscountNotes": "string",
"appliedAfterTaxDiscount": "number",
"balanceDue": "number",
"blazePayRequest": {
"cashBack": "number",
"fee": "number",
"tip": "number",
"totalCharged": "number"
},
"calcCartDiscount": "number",
"cardFeesLogs": [
{
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"enabled": "boolean",
"fee": "number",
"feeAmount": "number",
"feeType": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"subTotalThreshold": "number",
"type": "string",
"updated": "boolean"
}
],
"cartDiscountNotes": "string",
"cashReceived": "number",
"changeDue": "number",
"companyId": "string",
"consumerType": "string",
"created": "int64",
"creditCardFee": "number",
"currentAmount": "number",
"deleted": "boolean",
"deliveryDiscount": "number",
"deliveryDiscountType": "string",
"deliveryFee": "number",
"deliveryPromotionId": "string",
"discount": "number",
"discountType": "string",
"enableCreditCardFee": "boolean",
"enableDeliveryFee": "boolean",
"finalRefundAmt": "number",
"id": "string",
"items": [
{
"activeDiscountQty": "number",
"availableDiscountQty": "number",
"batchId": "string",
"batchSku": "string",
"calcCultivationTax": "number",
"calcDiscount": "number",
"calcPreTax": "number",
"calcTax": "number",
"cogs": "number",
"companyId": "string",
"cost": "number",
"created": "int64",
"deleted": "boolean",
"discount": "number",
"discountEnabled": "boolean",
"discountNotes": "string",
"discountType": "string",
"discountedQty": "number",
"exchangeAmount": "number",
"exchangeQty": "number",
"exciseTax": "number",
"externalId": "string",
"finalPrice": "number",
"finalized": "boolean",
"finalizedProductId": "string",
"fulfilled": "boolean",
"id": "string",
"ignoreMixMatch": "boolean",
"inventoryId": "string",
"mixMatched": "boolean",
"modified": "int64",
"orderItemId": "string",
"origOrderItemId": "string",
"origQuantity": "number",
"overridePrice": "number",
"parentId": "string",
"perUnitRefundAmt": "number",
"prepackage": {
"active": "boolean",
"companyId": "string",
"created": "int64",
"customWeight": "boolean",
"deleted": "boolean",
"dirty": "boolean",
"id": "string",
"modified": "int64",
"name": "string",
"price": "number",
"productId": "string",
"runningQuantity": "int32",
"shopId": "string",
"sku": "string",
"toleranceId": "string",
"unitValue": "number",
"updated": "boolean"
},
"prepackageId": "string",
"prepackageItemId": "string",
"prepackageProductItem": {
"active": "boolean",
"batchId": "string",
"batchSKU": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"id": "string",
"modified": "int64",
"prepackageId": "string",
"productId": "string",
"runningQuantity": "int32",
"shopId": "string",
"sku": "string",
"updated": "boolean"
},
"preparedQty": "number",
"product": {
"active": "boolean",
"assets": [
{
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
],
"automaticReOrder": "boolean",
"brand": {
"active": "boolean",
"brandLogo": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"companyId": "string",
"created": "int64",
"default": "boolean",
"deleted": "boolean",
"externalId": "string",
"id": "string",
"modified": "int64",
"name": "string",
"phoneNo": "string",
"updated": "boolean",
"vendorList": [
"string"
],
"website": "string"
},
"brandId": "string",
"bundleItems": [
{
"productId": "string",
"quantity": "number"
}
],
"byGram": "boolean",
"byPrepackage": "boolean",
"cannabisType": "string",
"category": {
"active": "boolean",
"cannabis": "boolean",
"cannabisType": "string",
"companyId": "string",
"complianceId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"externalId": "string",
"id": "string",
"lowThreshold": "number",
"modified": "int64",
"name": "string",
"photo": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"priority": "int32",
"shopId": "string",
"unitType": "string",
"updated": "boolean",
"wmCategory": "string"
},
"categoryId": "string",
"cbd": "double",
"cbda": "double",
"cbn": "double",
"committedQuantities": {
"<key>": "number"
},
"companyId": "string",
"complianceId": "string",
"created": "int64",
"customGramType": "string",
"customTaxInfo": {
"cityTax": "number",
"created": "int64",
"deleted": "boolean",
"federalTax": "number",
"id": "string",
"modified": "int64",
"stateTax": "number",
"updated": "boolean"
},
"customWeight": "number",
"deleted": "boolean",
"description": "string",
"dirty": "boolean",
"discountEnabled": "boolean",
"discountable": "boolean",
"dispatchPrepackageItemId": "string",
"enableExciseTax": "boolean",
"enableMixMatch": "boolean",
"enableWeedmap": "boolean",
"externalId": "string",
"flowerType": "string",
"genetics": "string",
"id": "string",
"importId": "string",
"importSrc": "string",
"instock": "boolean",
"lastLeaflySyncStatus": "boolean",
"lastLeaflySyncTime": "int64",
"lastWMSyncTime": "int64",
"lowInventoryNotification": "boolean",
"lowThreshold": "number",
"medicalConditions": [
{
"created": "int64",
"deleted": "boolean",
"id": "string",
"modified": "int64",
"name": "string",
"updated": "boolean"
}
],
"medicinal": "boolean",
"modified": "int64",
"name": "string",
"notes": [
{
"created": "int64",
"deleted": "boolean",
"enableOnFleet": "boolean",
"id": "string",
"message": "string",
"modified": "int64",
"updated": "boolean",
"writerId": "string",
"writerName": "string"
}
],
"overrideMetrcCategoryId": "string",
"potency": "boolean",
"potencyAmount": {
"cbd": "number",
"cbda": "number",
"cbn": "number",
"thc": "number",
"thca": "number"
},
"prepackageQuantities": {
"<key>": {
"committedQuantities": {
"<key>": "int32"
},
"sellableQuantities": {
"<key>": "int32"
},
"totalCommittedQuantity": "int32",
"totalSellableQuantity": "int32"
}
},
"priceBreaks": [
{
"active": "boolean",
"assignedPrice": "number",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"name": "string",
"price": "number",
"priceBreakType": "string",
"priority": "int32",
"quantity": "int32",
"salePrice": "number",
"updated": "boolean"
}
],
"priceIncludesALExcise": "boolean",
"priceIncludesExcise": "boolean",
"priceRanges": [
{
"assignedPrice": "number",
"id": "string",
"price": "number",
"priority": "int32",
"salePrice": "number",
"weightTolerance": {
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"enabled": "boolean",
"endWeight": "number",
"id": "string",
"modified": "int64",
"name": "string",
"priority": "int32",
"startWeight": "number",
"unitValue": "number",
"updated": "boolean",
"weightKey": "string",
"weightValue": "number"
},
"weightToleranceId": "string"
}
],
"pricingTemplateId": "string",
"producerAddress": {
"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"
},
"producerLicense": "string",
"producerMfg": "string",
"productSaleType": "string",
"productType": "string",
"qbItemRef": "string",
"quantities": [
{
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"id": "string",
"inventoryId": "string",
"modified": "int64",
"quantity": "number",
"shopId": "string",
"updated": "boolean"
}
],
"reOrderLevel": "number",
"salesPrice": "number",
"secondaryVendors": [
"string"
],
"sellable": "boolean",
"sellableQuantities": {
"<key>": "number"
},
"shopId": "string",
"showInWidget": "boolean",
"sku": "string",
"tags": [
"string"
],
"taxOrder": "string",
"taxTables": [
{
"active": "boolean",
"cityTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"companyId": "string",
"consumerType": "string",
"countyTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"federalTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"id": "string",
"modified": "int64",
"name": "string",
"shopId": "string",
"stateTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"taxOrder": "string",
"taxType": "string",
"updated": "boolean"
}
],
"taxType": "string",
"thc": "double",
"thca": "double",
"toleranceId": "string",
"totalCommittedQuantity": "number",
"totalSellableQuantity": "number",
"unitPrice": "number",
"unitValue": "number",
"updated": "boolean",
"usableMarijuana": "number",
"vendor": {
"accountOwnerId": "string",
"active": "boolean",
"additionalAddressList": [
{
"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"
}
],
"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"
},
"armsLengthType": "string",
"assets": [
{
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
],
"backOrderEnabled": "boolean",
"brands": [
"string"
],
"companyId": "string",
"companyLicenses": [
{
"companyType": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"licenseExpirationDate": "int64",
"licenseNumber": "string",
"licenseType": "string",
"modified": "int64",
"toDefault": "boolean",
"updated": "boolean"
}
],
"companyType": "string",
"connectedShop": "string",
"contactPerson": "string",
"created": "int64",
"createdBy": "string",
"credits": "number",
"dbaName": "string",
"defaultContactId": "string",
"defaultPaymentTerm": "string",
"deleted": "boolean",
"description": "string",
"email": "string",
"externalId": "string",
"fax": "string",
"firstName": "string",
"id": "string",
"importId": "string",
"lastName": "string",
"licenceType": "string",
"licenseExpirationDate": "int64",
"licenseNumber": "string",
"mobileNumber": "string",
"modified": "int64",
"name": "string",
"notes": [
{
"created": "int64",
"deleted": "boolean",
"enableOnFleet": "boolean",
"id": "string",
"message": "string",
"modified": "int64",
"updated": "boolean",
"writerId": "string",
"writerName": "string"
}
],
"phone": "string",
"qbVendorRef": [
{
"<key>": "string"
}
],
"relatedEntity": "boolean",
"salesPerson": "string",
"toDefault": "boolean",
"updated": "boolean",
"vendorType": "string",
"website": "string"
},
"vendorId": "string",
"weightPerUnit": "string",
"wmOnlineSellable": "boolean",
"wmThreshold": "number"
},
"productId": "string",
"promotionReqs": [
{
"assigned": "boolean",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"finalizedDiscountId": "string",
"id": "string",
"modified": "int64",
"promotionId": "string",
"rewardId": "string",
"updated": "boolean"
}
],
"quantity": "number",
"quantityLogs": [
{
"batchId": "string",
"id": "string",
"inventoryId": "string",
"packageLabel": "string",
"prepackageItemId": "string",
"quantity": "number"
}
],
"remarks": "string",
"status": "string",
"taxInfo": {
"cityTax": "number",
"created": "int64",
"deleted": "boolean",
"federalTax": "number",
"id": "string",
"modified": "int64",
"stateTax": "number",
"updated": "boolean"
},
"taxOrder": "string",
"taxResult": {
"created": "int64",
"cultivationTaxResult": {
"flowerTaxOz": "number",
"leafTaxOz": "number",
"plantTaxOz": "number",
"totalCultivationTax": "number",
"totalFlowerOz": "number",
"totalFlowerTax": "number",
"totalLeafOz": "number",
"totalLeafTax": "number",
"totalPlantOz": "number",
"totalPlantTax": "number"
},
"deleted": "boolean",
"id": "string",
"modified": "int64",
"taxMappingInfo": {
"<key>": "string"
},
"totalALExciseTax": "number",
"totalALPostExciseTax": "number",
"totalCityPreTax": "number",
"totalCityTax": "number",
"totalCountyPreTax": "number",
"totalCountyTax": "number",
"totalExciseTax": "number",
"totalFedPreTax": "number",
"totalFedTax": "number",
"totalNALPreExciseTax": "number",
"totalPostCalcTax": "number",
"totalPreCalcTax": "number",
"totalStatePreTax": "number",
"totalStateTax": "number",
"updated": "boolean"
},
"taxTable": {
"active": "boolean",
"cityTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"companyId": "string",
"consumerType": "string",
"countyTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"federalTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"id": "string",
"modified": "int64",
"name": "string",
"shopId": "string",
"stateTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"taxOrder": "string",
"taxType": "string",
"updated": "boolean"
},
"taxType": "string",
"totalRefundAmount": "number",
"totalRefundQty": "number",
"txnLineID": "string",
"txnLineIDMap": {
"<key>": "string"
},
"unitPrice": "number",
"unitQty": "int32",
"updated": "boolean",
"useUnitQty": "boolean",
"weightKey": "string"
}
],
"lastCreditCardFee": "number",
"modified": "int64",
"nonCannabisTaxTable": {
"active": "boolean",
"cityTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"companyId": "string",
"consumerType": "string",
"countyTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"federalTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"id": "string",
"modified": "int64",
"name": "string",
"shopId": "string",
"stateTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"taxOrder": "string",
"taxType": "string",
"updated": "boolean"
},
"paymentOption": "string",
"paymentType": "string",
"pointSpent": "number",
"promoCode": "string",
"promotionReqLogs": [
{
"amount": "number",
"assigned": "boolean",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"finalizedDiscountId": "string",
"id": "string",
"modified": "int64",
"promotionId": "string",
"promotionType": "string",
"rewardId": "string",
"stackable": "boolean",
"updated": "boolean"
}
],
"promotionReqs": [
{
"assigned": "boolean",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"finalizedDiscountId": "string",
"id": "string",
"modified": "int64",
"promotionId": "string",
"rewardId": "string",
"updated": "boolean"
}
],
"refundAmount": "number",
"refundOption": "string",
"refundOrderItemRequests": [
{
"created": "int64",
"createdById": "string",
"createdUser": "string",
"note": "string",
"orderItemId": "string",
"quantity": "number",
"refundAmt": "number",
"refundAs": "string",
"refundType": "string",
"withInventory": "boolean"
}
],
"requestRefundAmt": "number",
"roundAmt": "number",
"splitPayment": {
"cashAmt": "number",
"cashlessAmt": "number",
"checkAmt": "number",
"companyId": "string",
"created": "int64",
"creditDebitAmt": "number",
"deleted": "boolean",
"id": "string",
"modified": "int64",
"storeCreditAmt": "number",
"totalSplits": "number",
"updated": "boolean"
},
"storageLocation": "string",
"subTotal": "number",
"subTotalDiscount": "number",
"tax": "number",
"taxResult": {
"created": "int64",
"cultivationTaxResult": {
"flowerTaxOz": "number",
"leafTaxOz": "number",
"plantTaxOz": "number",
"totalCultivationTax": "number",
"totalFlowerOz": "number",
"totalFlowerTax": "number",
"totalLeafOz": "number",
"totalLeafTax": "number",
"totalPlantOz": "number",
"totalPlantTax": "number"
},
"deleted": "boolean",
"id": "string",
"modified": "int64",
"taxMappingInfo": {
"<key>": "string"
},
"totalALExciseTax": "number",
"totalALPostExciseTax": "number",
"totalCityPreTax": "number",
"totalCityTax": "number",
"totalCountyPreTax": "number",
"totalCountyTax": "number",
"totalExciseTax": "number",
"totalFedPreTax": "number",
"totalFedTax": "number",
"totalNALPreExciseTax": "number",
"totalPostCalcTax": "number",
"totalPreCalcTax": "number",
"totalStatePreTax": "number",
"totalStateTax": "number",
"updated": "boolean"
},
"taxRoundOffType": "string",
"taxTable": {
"active": "boolean",
"cityTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"companyId": "string",
"consumerType": "string",
"countyTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"federalTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"id": "string",
"modified": "int64",
"name": "string",
"shopId": "string",
"stateTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"taxOrder": "string",
"taxType": "string",
"updated": "boolean"
},
"tipAmount": "number",
"total": "number",
"totalALExciseTax": "number",
"totalCalcTax": "number",
"totalDiscount": "number",
"totalExciseTax": "number",
"totalFees": "number",
"totalPreCalcTax": "number",
"updated": "boolean"
},
"checkinTime": "int64",
"checkoutType": "string",
"companyId": "string",
"completeAfter": "int64",
"completedTime": "int64",
"consumerCartId": "string",
"createOnfleetTask": "boolean",
"createTookanTask": "boolean",
"created": "int64",
"createdByEmployee": {
"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"
},
"createdById": "string",
"defaultRegionByAddress": "boolean",
"deferred": "boolean",
"deferredNote": {
"created": "int64",
"deleted": "boolean",
"enableOnFleet": "boolean",
"id": "string",
"message": "string",
"modified": "int64",
"updated": "boolean",
"writerId": "string",
"writerName": "string"
},
"deferredTime": "int64",
"dejavooTerminalConfig": {
"authKey": "string",
"created": "int64",
"deleted": "boolean",
"enabled": "boolean",
"id": "string",
"manual": "boolean",
"modified": "int64",
"name": "string",
"online": "boolean",
"processors": [
"int32"
],
"registerId": "string",
"serialNumber": "string",
"terminalId": "string",
"updated": "boolean"
},
"deleteNote": {
"created": "int64",
"deleted": "boolean",
"enableOnFleet": "boolean",
"id": "string",
"message": "string",
"modified": "int64",
"updated": "boolean",
"writerId": "string",
"writerName": "string"
},
"deleted": "boolean",
"deliveryAddress": {
"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"
},
"deliveryDate": "int64",
"deliveryTraceMessage": "string",
"dirty": "boolean",
"dispatchCreatedTime": "int64",
"dispatchRegion": {
"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"
},
"dispatchRegionId": "string",
"dispatchShop": {
"active": "boolean",
"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"
},
"ageLimit": "int32",
"alExciseOnZeroPrice": "boolean",
"allowAnonymousOrders": "boolean",
"appTarget": "string",
"appendBrandNameWM": "boolean",
"assets": [
{
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
],
"autoCashDrawer": "boolean",
"bccEmailAddress": "string",
"blazeConnections": [
"string"
],
"blazePayFeeList": [
{
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"enabled": "boolean",
"fee": "number",
"feeType": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"subTotalThreshold": "number",
"type": "string",
"updated": "boolean"
}
],
"cartMinimums": {
"cartMinimumDetails": [
{
"distance": "number",
"enabled": "boolean",
"minimum": "number",
"zipCodes": [
"string"
]
}
],
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"minimumsType": "string",
"modified": "int64",
"updated": "boolean"
},
"checkDuplicateDl": "boolean",
"checkoutType": "string",
"companyId": "string",
"created": "int64",
"creditCardFeeList": [
{
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"enabled": "boolean",
"fee": "number",
"feeType": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"subTotalThreshold": "number",
"type": "string",
"updated": "boolean"
}
],
"creditFefundType": "string",
"defaultCountry": "string",
"defaultHandOverMin": "int32",
"defaultPinTimeout": "int32",
"deleted": "boolean",
"deliveryFee": "number",
"deliveryFees": [
{
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"distance": "number",
"enabled": "boolean",
"fee": "number",
"feeType": "string",
"id": "string",
"modified": "int64",
"subTotalThreshold": "number",
"type": "string",
"updated": "boolean",
"zipCodes": [
"string"
]
}
],
"deliveryMaxOrders": "int32",
"deliveryRefundType": "string",
"disableMedicalProductsForAdultUse": "boolean",
"emailAdress": "string",
"emailAttachment": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"emailList": [
"string"
],
"emailMessage": "string",
"enableAfterTaxDiscountNotes": "boolean",
"enableAgeLimit": "boolean",
"enableAutoPrintAtFulfillment": "boolean",
"enableBCCReceipt": "boolean",
"enableCannabisLimit": "boolean",
"enableCartDiscountNotes": "boolean",
"enableCashInOut": "boolean",
"enableCommittedValidation": "boolean",
"enableComplianceTesting": "boolean",
"enableCustomerIdentification": "boolean",
"enableDOBNameUniqueness": "boolean",
"enableDailySummaryEmail": "boolean",
"enableDeferTransactions": "boolean",
"enableDeliveryFee": "boolean",
"enableDeliverySignature": "boolean",
"enableDiscountNotes": "boolean",
"enableExciseTax": "boolean",
"enableGPSTracking": "boolean",
"enableHarvestTax": "boolean",
"enableIncomingOrders": "boolean",
"enableLowInventoryEmail": "boolean",
"enableMedicinalAge": "boolean",
"enableOnFleet": "boolean",
"enablePinForCashDrawer": "boolean",
"enableRefundNote": "boolean",
"enableSaleLogout": "boolean",
"enableSpringBig": "boolean",
"enableTip": "boolean",
"enableTipsBlazePay": "boolean",
"enableTookan": "boolean",
"enableUnAssignedOnfleetOrder": "boolean",
"enableWaive": "boolean",
"enableWooCommerce": "boolean",
"enforceCashDrawers": "boolean",
"exciseTaxType": "string",
"flowerType": [
"string"
],
"getdraftOrderTimeout": "int32",
"hubId": "string",
"hubName": "string",
"id": "string",
"invoiceNote": "string",
"invoiceTermCondition": "string",
"latitude": "double",
"legalLanguage": "string",
"license": "string",
"logo": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"longitude": "double",
"marketingSources": [
"string"
],
"medicinalAge": "int32",
"membersCountSyncDate": "int64",
"membersTag": [
"string"
],
"modified": "int64",
"nalExciseFromRetailCost": "boolean",
"name": "string",
"nextSnapshotTime": "int64",
"nonCannabisTaxes": {
"alExciseOnZeroPrice": "boolean",
"enableNonCannabisTax": "boolean",
"nalExciseFromRetailCost": "boolean",
"nonCannabisType": "string",
"taxInfo": {
"cityTax": "number",
"created": "int64",
"deleted": "boolean",
"federalTax": "number",
"id": "string",
"modified": "int64",
"stateTax": "number",
"updated": "boolean"
},
"taxOrder": "string",
"taxTables": [
{
"active": "boolean",
"cityTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"companyId": "string",
"consumerType": "string",
"countyTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"federalTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"id": "string",
"modified": "int64",
"name": "string",
"shopId": "string",
"stateTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"taxOrder": "string",
"taxType": "string",
"updated": "boolean"
}
],
"useComplexTax": "boolean"
},
"numAllowActiveTrans": "int32",
"onFleetAllowEmptyOrders": "boolean",
"onFleetApiKey": "string",
"onFleetOrganizationId": "string",
"onFleetOrganizationName": "string",
"onFleetRequired": "boolean",
"onFleetTwoAutoPack": "boolean",
"onFleetTwoWay": "boolean",
"onFleetTwoWayRevert": "boolean",
"onFleetTwoWayUpdateSchedule": "boolean",
"onfleetOverrideUrl": "string",
"onlineStoreInfo": {
"activeInventoryId": "string",
"cartMinType": "string",
"cartMinimum": "number",
"colorTheme": "string",
"companyId": "string",
"created": "int64",
"customCss": "string",
"customMessageETA": "string",
"defaultETA": "int32",
"deleted": "boolean",
"dirty": "boolean",
"enableDelivery": "boolean",
"enableDeliveryAreaRestrictions": "boolean",
"enableHtmlText": "boolean",
"enableInventory": "boolean",
"enableInventoryType": "string",
"enableOnlinePOS": "boolean",
"enableOnlineShipment": "boolean",
"enableOtherMarketingSource": "boolean",
"enableProductReviews": "boolean",
"enableStorePickup": "boolean",
"enabled": "boolean",
"htmlText": "string",
"id": "string",
"modified": "int64",
"pageOneMessageBody": "string",
"pageOneMessageTitle": "string",
"restrictedZipCodes": [
"string"
],
"shopId": "string",
"storeHexColor": "string",
"submissionMessage": "string",
"supportEmail": "string",
"updated": "boolean",
"useCustomETA": "boolean",
"viewType": "string",
"websiteOrigins": "string",
"websiteUrl": "string"
},
"orderTags": [
"string"
],
"pennyTransactionOption": "string",
"phoneNumber": "string",
"poNote": "string",
"poTermCondition": "string",
"productPriceIncludeExciseTax": "boolean",
"productsTag": [
"string"
],
"receiptInfo": [
{
"aboveFreeText": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"emailAttachment": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"emailMessage": "string",
"enableBrand": "boolean",
"enableEmployeeId": "boolean",
"enableEmployeeName": "boolean",
"enableExciseTaxAsItem": "boolean",
"enableIncludeItemInSKU": "boolean",
"enableItemDiscount": "boolean",
"enableItemDiscountNotes": "boolean",
"enableLicenseeBusinessName": "boolean",
"enableMemberAddress": "boolean",
"enableMemberId": "boolean",
"enableMemberLoyaltyPoints": "boolean",
"enableMemberName": "boolean",
"enableMemberPhoneNo": "boolean",
"enableNotes": "boolean",
"enableOrderDateTime": "boolean",
"enablePreparedByEmployeeId": "boolean",
"enableShopAddress": "boolean",
"enableShopLicenseNumber": "boolean",
"enableShopPhoneNo": "boolean",
"enabledBottomFreeText": "boolean",
"enabledFreeText": "boolean",
"freeText": "string",
"id": "string",
"licenseeBusinessName": "string",
"modified": "int64",
"receiptType": "string",
"shopId": "string",
"updated": "boolean"
}
],
"receivingInventoryId": "string",
"requireValidRecDate": "boolean",
"restrictIncomingOrderNotifications": "boolean",
"restrictedNotificationTerminals": [
"string"
],
"restrictedViews": "boolean",
"roundOffType": "string",
"roundUpMessage": "string",
"shopType": "string",
"shortIdentifier": "string",
"showDeliveryQueue": "boolean",
"showOnlineQueue": "boolean",
"showProductByAvailableQuantity": "boolean",
"showSpecialQueue": "boolean",
"showWalkInQueue": "boolean",
"snapshopTime": "int64",
"taxInfo": {
"cityTax": "number",
"created": "int64",
"deleted": "boolean",
"federalTax": "number",
"id": "string",
"modified": "int64",
"stateTax": "number",
"updated": "boolean"
},
"taxOrder": "string",
"taxRoundOffType": "string",
"taxTables": [
{
"active": "boolean",
"cityTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"companyId": "string",
"consumerType": "string",
"countyTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"federalTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"id": "string",
"modified": "int64",
"name": "string",
"shopId": "string",
"stateTax": {
"active": "boolean",
"activeExciseTax": "boolean",
"companyId": "string",
"compound": "boolean",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"displayName": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"taxOrder": "string",
"taxRate": "number",
"territory": "string",
"updated": "boolean"
},
"taxOrder": "string",
"taxType": "string",
"updated": "boolean"
}
],
"termSalesOption": "string",
"timeZone": "string",
"timezoneOffsetInMinutes": "int32",
"tookanRequired": "boolean",
"twilioNumber": "string",
"updated": "boolean",
"useAssignedEmployee": "boolean",
"useComplexTax": "boolean"
},
"draftCreatedTime": "int64",
"enableBlazePayTips": "boolean",
"endRouteDate": "int64",
"endRouteLocation": [
"double"
],
"endTime": "int64",
"entityISN": "string",
"estimatedLoyaltyPoints": "boolean",
"eta": "int32",
"fulfillingFulfillment": "boolean",
"fulfillmentStep": "string",
"hypurCheckinISN": "string",
"hypurPin": "string",
"id": "string",
"identifications": [
{
"assets": [
{
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
],
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"expirationDate": "int64",
"frontPhoto": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"id": "string",
"licenseNumber": "string",
"modified": "int64",
"state": "string",
"type": "string",
"updated": "boolean",
"verified": "boolean"
}
],
"inventory": {
"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"
},
"inventoryId": "string",
"loc": [
"double"
],
"locked": "boolean",
"member": {
"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"
},
"addresses": [
{
"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"
}
],
"agreementExpired": "boolean",
"anonymous": "boolean",
"banPatient": "boolean",
"careGivers": [
"string"
],
"companyId": "string",
"consumerType": "string",
"consumerUserId": "string",
"contracts": [
{
"companyId": "string",
"consumerId": "string",
"contractId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"employeeName": "string",
"employeeSignaturePhoto": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"id": "string",
"memberName": "string",
"membershipId": "string",
"modified": "int64",
"shopId": "string",
"signaturePhoto": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"signedDate": "int64",
"signedDigitally": "boolean",
"updated": "boolean",
"witnessName": "string",
"witnessSignaturePhoto": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
}
],
"cpn": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"dlExpired": "boolean",
"dob": "int64",
"email": "string",
"emailOptIn": "boolean",
"emailVerified": "boolean",
"enableLoyalty": "boolean",
"enabledCareGiver": "boolean",
"expStatuses": [
"string"
],
"firstName": "string",
"id": "string",
"identifications": [
{
"assets": [
{
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
],
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"expirationDate": "int64",
"frontPhoto": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"id": "string",
"licenseNumber": "string",
"modified": "int64",
"state": "string",
"type": "string",
"updated": "boolean",
"verified": "boolean"
}
],
"importId": "string",
"lastName": "string",
"lastVisitDate": "int64",
"lastestRecommendation": {
"assets": [
{
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
],
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"doctor": {
"active": "boolean",
"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"
},
"assets": [
{
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
],
"companyId": "string",
"created": "int64",
"degree": "string",
"deleted": "boolean",
"email": "string",
"fax": "string",
"firstName": "string",
"id": "string",
"importId": "string",
"lastName": "string",
"license": "string",
"modified": "int64",
"notes": [
{
"created": "int64",
"deleted": "boolean",
"enableOnFleet": "boolean",
"id": "string",
"message": "string",
"modified": "int64",
"updated": "boolean",
"writerId": "string",
"writerName": "string"
}
],
"phoneNumber": "string",
"searchText": "string",
"state": "string",
"updated": "boolean",
"website": "string"
},
"doctorId": "string",
"expirationDate": "int64",
"frontPhoto": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"id": "string",
"issueDate": "int64",
"limitExemption": "boolean",
"modified": "int64",
"recommendationNumber": "string",
"state": "string",
"temporary": "boolean",
"updated": "boolean",
"verified": "boolean",
"verifyMethod": "string",
"verifyPhoneNumber": "string",
"verifyWebsite": "string"
},
"lifetimePoints": "number",
"loyaltyPoints": "number",
"marketingSource": "string",
"medical": "boolean",
"memberGroup": {
"active": "boolean",
"companyId": "string",
"created": "int64",
"defaultGroup": "boolean",
"deleted": "boolean",
"dirty": "boolean",
"discount": "number",
"discountType": "string",
"enablePromotion": "boolean",
"id": "string",
"memberCount": "int32",
"memberCountEmailOptIn": "int32",
"memberCountTextOptIn": "int32",
"modified": "int64",
"name": "string",
"promotionId": "string",
"promotionShopMap": {
"<key>": "string"
},
"shopId": "string",
"updated": "boolean"
},
"memberGroupId": "string",
"middleName": "string",
"modified": "int64",
"notes": [
{
"created": "int64",
"deleted": "boolean",
"enableOnFleet": "boolean",
"id": "string",
"message": "string",
"modified": "int64",
"updated": "boolean",
"writerId": "string",
"writerName": "string"
}
],
"preferences": [
{
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"modified": "int64",
"name": "string",
"updated": "boolean"
}
],
"primaryPhone": "string",
"qbCustomerRef": [
{
"<key>": "string"
}
],
"recentProducts": [
"string"
],
"recommendationExpired": "boolean",
"recommendationExpiryLeft": "int64",
"recommendations": [
{
"assets": [
{
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
],
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"doctor": {
"active": "boolean",
"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"
},
"assets": [
{
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
],
"companyId": "string",
"created": "int64",
"degree": "string",
"deleted": "boolean",
"email": "string",
"fax": "string",
"firstName": "string",
"id": "string",
"importId": "string",
"lastName": "string",
"license": "string",
"modified": "int64",
"notes": [
{
"created": "int64",
"deleted": "boolean",
"enableOnFleet": "boolean",
"id": "string",
"message": "string",
"modified": "int64",
"updated": "boolean",
"writerId": "string",
"writerName": "string"
}
],
"phoneNumber": "string",
"searchText": "string",
"state": "string",
"updated": "boolean",
"website": "string"
},
"doctorId": "string",
"expirationDate": "int64",
"frontPhoto": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"id": "string",
"issueDate": "int64",
"limitExemption": "boolean",
"modified": "int64",
"recommendationNumber": "string",
"state": "string",
"temporary": "boolean",
"updated": "boolean",
"verified": "boolean",
"verifyMethod": "string",
"verifyPhoneNumber": "string",
"verifyWebsite": "string"
}
],
"regionId": "string",
"searchText": "string",
"sex": "string",
"shopId": "string",
"startDate": "int64",
"status": "string",
"tags": [
"string"
],
"textOptIn": "boolean",
"updated": "boolean",
"uppercaseCity": "string"
},
"memberId": "string",
"memberSignature": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"memo": "string",
"message": "string",
"metrcDeliveryId": "int64",
"metrcDeliverySubmitStatus": "string",
"metrcDeliverySubmitTime": "int64",
"metrcId": "int64",
"metrcSaleTime": "string",
"metrcSubmissionCompleteTime": "int64",
"metrcSubmissionDeleteTime": "int64",
"mileage": "number",
"mileageCalculated": "boolean",
"modified": "int64",
"mtracTxnId": "string",
"note": {
"created": "int64",
"deleted": "boolean",
"enableOnFleet": "boolean",
"id": "string",
"message": "string",
"modified": "int64",
"updated": "boolean",
"writerId": "string",
"writerName": "string"
},
"onFleetError": "string",
"onFleetTaskId": "string",
"onFleetTaskStatus": "string",
"onFleetTeamId": "string",
"onfleetTwoWaySuccess": "boolean",
"orderTags": [
"string"
],
"overrideInventoryId": "string",
"packedBy": "string",
"packedByEmployee": {
"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"
},
"packedDate": "int64",
"paid": "boolean",
"paidAmount": "number",
"paidTime": "int64",
"parentTransactionId": "string",
"payingWithPaymentCard": "boolean",
"paymentCardPayments": [
{
"amount": "number",
"balance": "number",
"cardEncrypted": "string",
"created": "int64",
"currency": "string",
"cvv": "string",
"deleted": "boolean",
"email": "string",
"expMonth": "int32",
"expYear": "int32",
"exp_date": "string",
"first6": "string",
"first_name": "string",
"id": "string",
"last4": "string",
"last_name": "string",
"modified": "int64",
"paymentCardNumber": "string",
"paymentId": "string",
"phone_number": "string",
"processedTime": "int64",
"status": "string",
"statusMessage": "string",
"type": "string",
"updated": "boolean"
}
],
"paymentEditedBy": "string",
"paymentEditedTime": "int64",
"paymentReceived": "number",
"payments": [
{
"amount": "number",
"batchNum": "int32",
"calculatedAmount": "number",
"cardFee": "number",
"cardFeesLog": {
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"enabled": "boolean",
"fee": "number",
"feeAmount": "number",
"feeType": "string",
"id": "string",
"modified": "int64",
"shopId": "string",
"subTotalThreshold": "number",
"type": "string",
"updated": "boolean"
},
"cashBack": "number",
"changeDue": "number",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"id": "string",
"invNum": "int32",
"manual": "boolean",
"modified": "int64",
"paymentOption": "string",
"paymentReceived": "number",
"posTerminal": {
"authKey": "string",
"created": "int64",
"deleted": "boolean",
"enabled": "boolean",
"id": "string",
"manual": "boolean",
"modified": "int64",
"name": "string",
"online": "boolean",
"processors": [
"int32"
],
"registerId": "string",
"serialNumber": "string",
"terminalId": "string",
"updated": "boolean"
},
"processor": "int32",
"refID": "string",
"requestId": "string",
"shopId": "string",
"split": "boolean",
"terminal": {
"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"
},
"tips": "number",
"total": "number",
"transNo": "string",
"transactionFee": "number",
"transactionId": "string",
"updated": "boolean",
"voidT": "boolean"
}
],
"pickUpDate": "int64",
"pointsEarned": "number",
"preparedBy": "string",
"preparedByEmployee": {
"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"
},
"preparedDate": "int64",
"preparingFulfillment": "boolean",
"previousBalance": "number",
"priority": "int64",
"processedTime": "int64",
"qbJournalEntryRef": "string",
"qbRefundReceipt": "string",
"qbSalesReceiptRef": "string",
"queueBlazePayId": "string",
"queueType": "string",
"refundPaymentOptions": [
"string"
],
"refundVersion": "string",
"routing": "boolean",
"seller": {
"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"
},
"sellerId": "string",
"sellerTerminal": {
"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"
},
"sellerTerminalId": "string",
"sessionId": "string",
"shopId": "string",
"shortId": "string",
"source": "string",
"startRouteDate": "int64",
"startRouteLocation": [
"double"
],
"startTime": "int64",
"state": "int32",
"status": "string",
"terminal": {
"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"
},
"terminalId": "string",
"timeZone": "string",
"tookanTaskId": "string",
"traceMessage": "string",
"traceSubmitStatus": "string",
"traceSubmitTime": "int64",
"trackingStatus": "string",
"transNo": "string",
"transType": "string",
"transactionRefundStatus": "string",
"transferRequest": {
"fromShopId": "string",
"toShopId": "string",
"transfers": [
{
"fromBatchId": "string",
"fromInventoryId": "string",
"prepackageItemId": "string",
"productId": "string",
"toBatchId": "string",
"toInventoryId": "string",
"transferAmount": "number"
}
]
},
"transferShopId": "string",
"updated": "boolean",
"voidDate": "int64",
"voidedByEmployeeId": "string",
"waivedDate": "int64",
"waivedStatus": "boolean"
}Properties
| Name | Type | Description | Additional |
|---|---|---|---|
| active | boolean | Optional | |
| addressUpdate | boolean | Optional | |
| assets[] | array | Optional | |
| assets[].active | boolean | Optional | |
| assets[].assetType | string |
Possible values are:
|
Optional |
| assets[].companyId | string | Optional | |
| assets[].created | int64 | Optional | |
| assets[].deleted | boolean | Optional | |
| assets[].id | string | Optional | |
| assets[].key | string | Optional | |
| assets[].largeURL | string | Optional | |
| assets[].largeX2URL | string | Optional | |
| assets[].mediumURL | string | Optional | |
| assets[].modified | int64 | Optional | |
| assets[].name | string | Optional | |
| assets[].origURL | string | Optional | |
| assets[].priority | int32 | Optional | |
| assets[].publicURL | string | Optional | |
| assets[].secured | boolean | Optional | |
| assets[].thumbURL | string | Optional | |
| assets[].type | string |
Possible values are:
|
Optional |
| assets[].updated | boolean | Optional | |
| assigned | boolean | Optional | |
| assignedEmployee | object | Employee | Optional |
| assignedEmployee.address | object | Address | Optional |
| assignedEmployee.address.address | string | Optional | |
| assignedEmployee.address.addressLine2 | string | Optional | |
| assignedEmployee.address.city | string | Optional | |
| assignedEmployee.address.companyId | string | Optional | |
| assignedEmployee.address.country | string | Optional | |
| assignedEmployee.address.created | int64 | Optional | |
| assignedEmployee.address.deleted | boolean | Optional | |
| assignedEmployee.address.id | string | Optional | |
| assignedEmployee.address.latitude | number | Optional | |
| assignedEmployee.address.longitude | number | Optional | |
| assignedEmployee.address.modified | int64 | Optional | |
| assignedEmployee.address.state | string | Optional | |
| assignedEmployee.address.updated | boolean | Optional | |
| assignedEmployee.address.zipCode | string | Optional | |
| assignedEmployee.appAccessList[] | array of string |
Possible values are:
|
Optional |
| assignedEmployee.assignedInventoryId | string | Optional | |
| assignedEmployee.assignedTerminalId | string | Optional | |
| assignedEmployee.canApplyCustomDiscount | boolean | Optional | |
| assignedEmployee.cashDrawerStatus | string |
Possible values are:
|
Optional |
| assignedEmployee.companyId | string | Optional | |
| assignedEmployee.created | int64 | Optional | |
| assignedEmployee.deleted | boolean | Optional | |
| assignedEmployee.disabled | boolean | Optional | |
| assignedEmployee.dlExpirationDate | string | Optional | |
| assignedEmployee.driver | boolean | Optional | |
| assignedEmployee.driversLicense | string | Optional | |
| assignedEmployee.email | string | Optional | |
| assignedEmployee.employeeOnFleetInfoList[] | array | Optional | |
| assignedEmployee.employeeOnFleetInfoList[].onFleetTeamList[] | array of string | Optional | |
| assignedEmployee.employeeOnFleetInfoList[].onFleetWorkerId | string | Optional | |
| assignedEmployee.employeeOnFleetInfoList[].shopId | string | Optional | |
| assignedEmployee.externalId | string | Optional | |
| assignedEmployee.firstName | string | Optional | |
| assignedEmployee.id | string | Optional | |
| assignedEmployee.insuranceCompanyName | string | Optional | |
| assignedEmployee.insuranceExpireDate | int64 | Optional | |
| assignedEmployee.inventoryName | string | Optional | |
| assignedEmployee.lastLoggedInShopId | string | Optional | |
| assignedEmployee.lastLoginTime | int64 | Optional | |
| assignedEmployee.lastName | string | Optional | |
| assignedEmployee.modified | int64 | Optional | |
| assignedEmployee.notes[] | array | Optional | |
| assignedEmployee.notes[].created | int64 | Optional | |
| assignedEmployee.notes[].deleted | boolean | Optional | |
| assignedEmployee.notes[].enableOnFleet | boolean | Optional | |
| assignedEmployee.notes[].id | string | Optional | |
| assignedEmployee.notes[].message | string | Optional | |
| assignedEmployee.notes[].modified | int64 | Optional | |
| assignedEmployee.notes[].updated | boolean | Optional | |
| assignedEmployee.notes[].writerId | string | Optional | |
| assignedEmployee.notes[].writerName | string | Optional | |
| assignedEmployee.occupationLicenseNumber | string | Optional | |
| assignedEmployee.organizationIds[] | array of string | Optional | |
| assignedEmployee.password | string | Optional | |
| assignedEmployee.phoneNumber | string | Optional | |
| assignedEmployee.pin | string | Optional | |
| assignedEmployee.policyNumber | string | Optional | |
| assignedEmployee.recentLocation | object | TerminalLocation | Optional |
| assignedEmployee.recentLocation.companyId | string | Optional | |
| assignedEmployee.recentLocation.created | int64 | Optional | |
| assignedEmployee.recentLocation.deleted | boolean | Optional | |
| assignedEmployee.recentLocation.deviceId | string | Optional | |
| assignedEmployee.recentLocation.dirty | boolean | Optional | |
| assignedEmployee.recentLocation.employeeId | string | Optional | |
| assignedEmployee.recentLocation.id | string | Optional | |
| assignedEmployee.recentLocation.loc[] | array of double | Optional | |
| assignedEmployee.recentLocation.modified | int64 | Optional | |
| assignedEmployee.recentLocation.name | string | Optional | |
| assignedEmployee.recentLocation.shopId | string | Optional | |
| assignedEmployee.recentLocation.terminalId | string | Optional | |
| assignedEmployee.recentLocation.timeCardId | string | Optional | |
| assignedEmployee.recentLocation.updated | boolean | Optional | |
| assignedEmployee.registrationExpireDate | int64 | Optional | |
| assignedEmployee.role | object | Role | Optional |
| assignedEmployee.role.companyId | string | Optional | |
| assignedEmployee.role.created | int64 | Optional | |
| assignedEmployee.role.deleted | boolean | Optional | |
| assignedEmployee.role.id | string | Optional | |
| assignedEmployee.role.modified | int64 | Optional | |
| assignedEmployee.role.name | string | Optional | |
| assignedEmployee.role.permissions[] | array of string |
Possible values are:
|
Optional |
| assignedEmployee.role.updated | boolean | Optional | |
| assignedEmployee.roleId | string | Optional | |
| assignedEmployee.shops[] | array of string | Optional | |
| assignedEmployee.terminalName | string | Optional | |
| assignedEmployee.timeCard | object | TimeCard | Optional |
| assignedEmployee.timeCard.clockInTime | int64 | Optional | |
| assignedEmployee.timeCard.clockOutTime | int64 | Optional | |
| assignedEmployee.timeCard.clockin | boolean | Optional | |
| assignedEmployee.timeCard.companyId | string | Optional | |
| assignedEmployee.timeCard.created | int64 | Optional | |
| assignedEmployee.timeCard.deleted | boolean | Optional | |
| assignedEmployee.timeCard.dirty | boolean | Optional | |
| assignedEmployee.timeCard.employeeId | string | Optional | |
| assignedEmployee.timeCard.id | string | Optional | |
| assignedEmployee.timeCard.modified | int64 | Optional | |
| assignedEmployee.timeCard.sessions[] | array | Optional | |
| assignedEmployee.timeCard.sessions[].companyId | string | Optional | |
| assignedEmployee.timeCard.sessions[].created | int64 | Optional | |
| assignedEmployee.timeCard.sessions[].deleted | boolean | Optional | |
| assignedEmployee.timeCard.sessions[].dirty | boolean | Optional | |
| assignedEmployee.timeCard.sessions[].employeeId | string | Optional | |
| assignedEmployee.timeCard.sessions[].endTime | int64 | Optional | |
| assignedEmployee.timeCard.sessions[].id | string | Optional | |
| assignedEmployee.timeCard.sessions[].modified | int64 | Optional | |
| assignedEmployee.timeCard.sessions[].shopId | string | Optional | |
| assignedEmployee.timeCard.sessions[].startTime | int64 | Optional | |
| assignedEmployee.timeCard.sessions[].terminalId | string | Optional | |
| assignedEmployee.timeCard.sessions[].timeCardId | string | Optional | |
| assignedEmployee.timeCard.sessions[].updated | boolean | Optional | |
| assignedEmployee.timeCard.shopId | string | Optional | |
| assignedEmployee.timeCard.updated | boolean | Optional | |
| assignedEmployee.timecardId | string | Optional | |
| assignedEmployee.tookanInfoList[] | array | Optional | |
| assignedEmployee.tookanInfoList[].shopId | string | Optional | |
| assignedEmployee.tookanInfoList[].status | string |
Possible values are:
|
Optional |
| assignedEmployee.tookanInfoList[].teamId | string | Optional | |
| assignedEmployee.tookanInfoList[].tookanAgentId | string | Optional | |
| assignedEmployee.updated | boolean | Optional | |
| assignedEmployee.vehicleLicensePlate | string | Optional | |
| assignedEmployee.vehicleMake | string | Optional | |
| assignedEmployee.vehicleModel | string | Optional | |
| assignedEmployee.vehiclePin | string | Optional | |
| assignedEmployee.vinNo | string | Optional | |
| assignedEmployeeId | string | Optional | |
| autoAccepted | boolean | Optional | |
| balance | number | Optional | |
| blazeCashBack | number | Optional | |
| blazeFee | number | Optional | |
| blazeTip | number | Optional | |
| blazeTotalCharged | number | Optional | |
| cart | object | Cart | Optional |
| cart.adjustmentAmount | number | Optional | |
| cart.adjustmentInfoList[] | array | Optional | |
| cart.adjustmentInfoList[].adjustmentId | string | Optional | |
| cart.adjustmentInfoList[].amount | number | Optional | |
| cart.adjustmentInfoList[].negative | boolean | Optional | |
| cart.afterTaxDiscount | number | Optional | |
| cart.afterTaxDiscountNotes | string | Optional | |
| cart.appliedAfterTaxDiscount | number | Optional | |
| cart.balanceDue | number | Optional | |
| cart.blazePayRequest | object | BlazePayRequest | Optional |
| cart.blazePayRequest.cashBack | number | Optional | |
| cart.blazePayRequest.fee | number | Optional | |
| cart.blazePayRequest.tip | number | Optional | |
| cart.blazePayRequest.totalCharged | number | Optional | |
| cart.calcCartDiscount | number | Optional | |
| cart.cardFeesLogs[] | array | Optional | |
| cart.cardFeesLogs[].companyId | string | Optional | |
| cart.cardFeesLogs[].created | int64 | Optional | |
| cart.cardFeesLogs[].deleted | boolean | Optional | |
| cart.cardFeesLogs[].dirty | boolean | Optional | |
| cart.cardFeesLogs[].enabled | boolean | Optional | |
| cart.cardFeesLogs[].fee | number | Optional | |
| cart.cardFeesLogs[].feeAmount | number | Optional | |
| cart.cardFeesLogs[].feeType | string |
Possible values are:
|
Optional |
| cart.cardFeesLogs[].id | string | Optional | |
| cart.cardFeesLogs[].modified | int64 | Optional | |
| cart.cardFeesLogs[].shopId | string | Optional | |
| cart.cardFeesLogs[].subTotalThreshold | number | Optional | |
| cart.cardFeesLogs[].type | string |
Possible values are:
|
Optional |
| cart.cardFeesLogs[].updated | boolean | Optional | |
| cart.cartDiscountNotes | string | Optional | |
| cart.cashReceived | number | Optional | |
| cart.changeDue | number | Optional | |
| cart.companyId | string | Optional | |
| cart.consumerType | string |
Possible values are:
|
Optional |
| cart.created | int64 | Optional | |
| cart.creditCardFee | number | Optional | |
| cart.currentAmount | number | Optional | |
| cart.deleted | boolean | Optional | |
| cart.deliveryDiscount | number | Optional | |
| cart.deliveryDiscountType | string |
Possible values are:
|
Optional |
| cart.deliveryFee | number | Optional | |
| cart.deliveryPromotionId | string | Optional | |
| cart.discount | number | Optional | |
| cart.discountType | string |
Possible values are:
|
Optional |
| cart.enableCreditCardFee | boolean | Optional | |
| cart.enableDeliveryFee | boolean | Optional | |
| cart.finalRefundAmt | number | Optional | |
| cart.id | string | Optional | |
| cart.items[] | array | Optional | |
| cart.items[].activeDiscountQty | number | Optional | |
| cart.items[].availableDiscountQty | number | Optional | |
| cart.items[].batchId | string | Optional | |
| cart.items[].batchSku | string | Optional | |
| cart.items[].calcCultivationTax | number | Optional | |
| cart.items[].calcDiscount | number | Optional | |
| cart.items[].calcPreTax | number | Optional | |
| cart.items[].calcTax | number | Optional | |
| cart.items[].cogs | number | Optional | |
| cart.items[].companyId | string | Optional | |
| cart.items[].cost | number | Optional | |
| cart.items[].created | int64 | Optional | |
| cart.items[].deleted | boolean | Optional | |
| cart.items[].discount | number | Optional | |
| cart.items[].discountEnabled | boolean | Optional | |
| cart.items[].discountNotes | string | Optional | |
| cart.items[].discountType | string |
Possible values are:
|
Optional |
| cart.items[].discountedQty | number | Optional | |
| cart.items[].exchangeAmount | number | Optional | |
| cart.items[].exchangeQty | number | Optional | |
| cart.items[].exciseTax | number | Optional | |
| cart.items[].externalId | string | Optional | |
| cart.items[].finalPrice | number | Optional | |
| cart.items[].finalized | boolean | Optional | |
| cart.items[].finalizedProductId | string | Optional | |
| cart.items[].fulfilled | boolean | Optional | |
| cart.items[].id | string | Optional | |
| cart.items[].ignoreMixMatch | boolean | Optional | |
| cart.items[].inventoryId | string | Optional | |
| cart.items[].mixMatched | boolean | Optional | |
| cart.items[].modified | int64 | Optional | |
| cart.items[].orderItemId | string | Optional | |
| cart.items[].origOrderItemId | string | Optional | |
| cart.items[].origQuantity | number | Optional | |
| cart.items[].overridePrice | number | Optional | |
| cart.items[].parentId | string | Optional | |
| cart.items[].perUnitRefundAmt | number | Optional | |
| cart.items[].prepackage | object | Prepackage | Optional |
| cart.items[].prepackage.active | boolean | Optional | |
| cart.items[].prepackage.companyId | string | Optional | |
| cart.items[].prepackage.created | int64 | Optional | |
| cart.items[].prepackage.customWeight | boolean | Optional | |
| cart.items[].prepackage.deleted | boolean | Optional | |
| cart.items[].prepackage.dirty | boolean | Optional | |
| cart.items[].prepackage.id | string | Optional | |
| cart.items[].prepackage.modified | int64 | Optional | |
| cart.items[].prepackage.name | string | Optional | |
| cart.items[].prepackage.price | number | Optional | |
| cart.items[].prepackage.productId | string | Optional | |
| cart.items[].prepackage.runningQuantity | int32 | Optional | |
| cart.items[].prepackage.shopId | string | Optional | |
| cart.items[].prepackage.sku | string | Optional | |
| cart.items[].prepackage.toleranceId | string | Optional | |
| cart.items[].prepackage.unitValue | number | Optional | |
| cart.items[].prepackage.updated | boolean | Optional | |
| cart.items[].prepackageId | string | Optional | |
| cart.items[].prepackageItemId | string | Optional | |
| cart.items[].prepackageProductItem | object | PrepackageProductItem | Optional |
| cart.items[].prepackageProductItem.active | boolean | Optional | |
| cart.items[].prepackageProductItem.batchId | string | Optional | |
| cart.items[].prepackageProductItem.batchSKU | string | Optional | |
| cart.items[].prepackageProductItem.companyId | string | Optional | |
| cart.items[].prepackageProductItem.created | int64 | Optional | |
| cart.items[].prepackageProductItem.deleted | boolean | Optional | |
| cart.items[].prepackageProductItem.dirty | boolean | Optional | |
| cart.items[].prepackageProductItem.id | string | Optional | |
| cart.items[].prepackageProductItem.modified | int64 | Optional | |
| cart.items[].prepackageProductItem.prepackageId | string | Optional | |
| cart.items[].prepackageProductItem.productId | string | Optional | |
| cart.items[].prepackageProductItem.runningQuantity | int32 | Optional | |
| cart.items[].prepackageProductItem.shopId | string | Optional | |
| cart.items[].prepackageProductItem.sku | string | Optional | |
| cart.items[].prepackageProductItem.updated | boolean | Optional | |
| cart.items[].preparedQty | number | Optional | |
| cart.items[].product | object | Product | Optional |
| cart.items[].product.active | boolean | Optional | |
| cart.items[].product.assets[] | array | Optional | |
| cart.items[].product.assets[].active | boolean | Optional | |
| cart.items[].product.assets[].assetType | string |
Possible values are:
|
Optional |
| cart.items[].product.assets[].companyId | string | Optional | |
| cart.items[].product.assets[].created | int64 | Optional | |
| cart.items[].product.assets[].deleted | boolean | Optional | |
| cart.items[].product.assets[].id | string | Optional | |
| cart.items[].product.assets[].key | string | Optional | |
| cart.items[].product.assets[].largeURL | string | Optional | |
| cart.items[].product.assets[].largeX2URL | string | Optional | |
| cart.items[].product.assets[].mediumURL | string | Optional | |
| cart.items[].product.assets[].modified | int64 | Optional | |
| cart.items[].product.assets[].name | string | Optional | |
| cart.items[].product.assets[].origURL | string | Optional | |
| cart.items[].product.assets[].priority | int32 | Optional | |
| cart.items[].product.assets[].publicURL | string | Optional | |
| cart.items[].product.assets[].secured | boolean | Optional | |
| cart.items[].product.assets[].thumbURL | string | Optional | |
| cart.items[].product.assets[].type | string |
Possible values are:
|
Optional |
| cart.items[].product.assets[].updated | boolean | Optional | |
| cart.items[].product.automaticReOrder | boolean | Optional | |
| cart.items[].product.brand | object | Brand | Optional |
| cart.items[].product.brand.active | boolean | Optional | |
| cart.items[].product.brand.brandLogo | object | CompanyAsset | Optional |
| cart.items[].product.brand.brandLogo.active | boolean | Optional | |
| cart.items[].product.brand.brandLogo.assetType | string |
Possible values are:
|
Optional |
| cart.items[].product.brand.brandLogo.companyId | string | Optional | |
| cart.items[].product.brand.brandLogo.created | int64 | Optional | |
| cart.items[].product.brand.brandLogo.deleted | boolean | Optional | |
| cart.items[].product.brand.brandLogo.id | string | Optional | |
| cart.items[].product.brand.brandLogo.key | string | Optional | |
| cart.items[].product.brand.brandLogo.largeURL | string | Optional | |
| cart.items[].product.brand.brandLogo.largeX2URL | string | Optional | |
| cart.items[].product.brand.brandLogo.mediumURL | string | Optional | |
| cart.items[].product.brand.brandLogo.modified | int64 | Optional | |
| cart.items[].product.brand.brandLogo.name | string | Optional | |
| cart.items[].product.brand.brandLogo.origURL | string | Optional | |
| cart.items[].product.brand.brandLogo.priority | int32 | Optional | |
| cart.items[].product.brand.brandLogo.publicURL | string | Optional | |
| cart.items[].product.brand.brandLogo.secured | boolean | Optional | |
| cart.items[].product.brand.brandLogo.thumbURL | string | Optional | |
| cart.items[].product.brand.brandLogo.type | string |
Possible values are:
|
Optional |
| cart.items[].product.brand.brandLogo.updated | boolean | Optional | |
| cart.items[].product.brand.companyId | string | Optional | |
| cart.items[].product.brand.created | int64 | Optional | |
| cart.items[].product.brand.default | boolean | Optional | |
| cart.items[].product.brand.deleted | boolean | Optional | |
| cart.items[].product.brand.externalId | string | Optional | |
| cart.items[].product.brand.id | string | Optional | |
| cart.items[].product.brand.modified | int64 | Optional | |
| cart.items[].product.brand.name | string | Optional | |
| cart.items[].product.brand.phoneNo | string | Optional | |
| cart.items[].product.brand.updated | boolean | Optional | |
| cart.items[].product.brand.vendorList[] | array of string | Optional | |
| cart.items[].product.brand.website | string | Optional | |
| cart.items[].product.brandId | string | Optional | |
| cart.items[].product.bundleItems[] | array | Optional | |
| cart.items[].product.bundleItems[].productId | string | Optional | |
| cart.items[].product.bundleItems[].quantity | number | Optional | |
| cart.items[].product.byGram | boolean | Optional | |
| cart.items[].product.byPrepackage | boolean | Optional | |
| cart.items[].product.cannabisType | string |
Possible values are:
|
Optional |
| cart.items[].product.category | object | ProductCategory | Optional |
| cart.items[].product.category.active | boolean | Optional | |
| cart.items[].product.category.cannabis | boolean | Optional | |
| cart.items[].product.category.cannabisType | string |
Possible values are:
|
Optional |
| cart.items[].product.category.companyId | string | Optional | |
| cart.items[].product.category.complianceId | string | Optional | |
| cart.items[].product.category.created | int64 | Optional | |
| cart.items[].product.category.deleted | boolean | Optional | |
| cart.items[].product.category.dirty | boolean | Optional | |
| cart.items[].product.category.externalId | string | Optional | |
| cart.items[].product.category.id | string | Optional | |
| cart.items[].product.category.lowThreshold | number | Optional | |
| cart.items[].product.category.modified | int64 | Optional | |
| cart.items[].product.category.name | string | Optional | |
| cart.items[].product.category.photo | object | CompanyAsset | Optional |
| cart.items[].product.category.photo.active | boolean | Optional | |
| cart.items[].product.category.photo.assetType | string |
Possible values are:
|
Optional |
| cart.items[].product.category.photo.companyId | string | Optional | |
| cart.items[].product.category.photo.created | int64 | Optional | |
| cart.items[].product.category.photo.deleted | boolean | Optional | |
| cart.items[].product.category.photo.id | string | Optional | |
| cart.items[].product.category.photo.key | string | Optional | |
| cart.items[].product.category.photo.largeURL | string | Optional | |
| cart.items[].product.category.photo.largeX2URL | string | Optional | |
| cart.items[].product.category.photo.mediumURL | string | Optional | |
| cart.items[].product.category.photo.modified | int64 | Optional | |
| cart.items[].product.category.photo.name | string | Optional | |
| cart.items[].product.category.photo.origURL | string | Optional | |
| cart.items[].product.category.photo.priority | int32 | Optional | |
| cart.items[].product.category.photo.publicURL | string | Optional | |
| cart.items[].product.category.photo.secured | boolean | Optional | |
| cart.items[].product.category.photo.thumbURL | string | Optional | |
| cart.items[].product.category.photo.type | string |
Possible values are:
|
Optional |
| cart.items[].product.category.photo.updated | boolean | Optional | |
| cart.items[].product.category.priority | int32 | Optional | |
| cart.items[].product.category.shopId | string | Optional | |
| cart.items[].product.category.unitType | string |
Possible values are:
|
Optional |
| cart.items[].product.category.updated | boolean | Optional | |
| cart.items[].product.category.wmCategory | string | Optional | |
| cart.items[].product.categoryId | string | Optional | |
| cart.items[].product.cbd | double | Optional | |
| cart.items[].product.cbda | double | Optional | |
| cart.items[].product.cbn | double | Optional | |
| cart.items[].product.committedQuantities | object | Optional | |
| cart.items[].product.committedQuantities.<key> | map of number | Optional | |
| cart.items[].product.companyId | string | Optional | |
| cart.items[].product.complianceId | string | Optional | |
| cart.items[].product.created | int64 | Optional | |
| cart.items[].product.customGramType | string |
Possible values are:
|
Optional |
| cart.items[].product.customTaxInfo | object | TaxInfo | Optional |
| cart.items[].product.customTaxInfo.cityTax | number | Optional | |
| cart.items[].product.customTaxInfo.created | int64 | Optional | |
| cart.items[].product.customTaxInfo.deleted | boolean | Optional | |
| cart.items[].product.customTaxInfo.federalTax | number | Optional | |
| cart.items[].product.customTaxInfo.id | string | Optional | |
| cart.items[].product.customTaxInfo.modified | int64 | Optional | |
| cart.items[].product.customTaxInfo.stateTax | number | Optional | |
| cart.items[].product.customTaxInfo.updated | boolean | Optional | |
| cart.items[].product.customWeight | number | Optional | |
| cart.items[].product.deleted | boolean | Optional | |
| cart.items[].product.description | string | Optional | |
| cart.items[].product.dirty | boolean | Optional | |
| cart.items[].product.discountEnabled | boolean | Optional | |
| cart.items[].product.discountable | boolean | Optional | |
| cart.items[].product.dispatchPrepackageItemId | string | Optional | |
| cart.items[].product.enableExciseTax | boolean | Optional | |
| cart.items[].product.enableMixMatch | boolean | Optional | |
| cart.items[].product.enableWeedmap | boolean | Optional | |
| cart.items[].product.externalId | string | Optional | |
| cart.items[].product.flowerType | string | Optional | |
| cart.items[].product.genetics | string | Optional | |
| cart.items[].product.id | string | Optional | |
| cart.items[].product.importId | string | Optional | |
| cart.items[].product.importSrc | string | Optional | |
| cart.items[].product.instock | boolean | Optional | |
| cart.items[].product.lastLeaflySyncStatus | boolean | Optional | |
| cart.items[].product.lastLeaflySyncTime | int64 | Optional | |
| cart.items[].product.lastWMSyncTime | int64 | Optional | |
| cart.items[].product.lowInventoryNotification | boolean | Optional | |
| cart.items[].product.lowThreshold | number | Optional | |
| cart.items[].product.medicalConditions[] | array | Optional | |
| cart.items[].product.medicalConditions[].created | int64 | Optional | |
| cart.items[].product.medicalConditions[].deleted | boolean | Optional | |
| cart.items[].product.medicalConditions[].id | string | Optional | |
| cart.items[].product.medicalConditions[].modified | int64 | Optional | |
| cart.items[].product.medicalConditions[].name | string | Optional | |
| cart.items[].product.medicalConditions[].updated | boolean | Optional | |
| cart.items[].product.medicinal | boolean | Optional | |
| cart.items[].product.modified | int64 | Optional | |
| cart.items[].product.name | string |
product name |
|
| cart.items[].product.notes[] | array | Optional | |
| cart.items[].product.notes[].created | int64 | Optional | |
| cart.items[].product.notes[].deleted | boolean | Optional | |
| cart.items[].product.notes[].enableOnFleet | boolean | Optional | |
| cart.items[].product.notes[].id | string | Optional | |
| cart.items[].product.notes[].message | string | Optional | |
| cart.items[].product.notes[].modified | int64 | Optional | |
| cart.items[].product.notes[].updated | boolean | Optional | |
| cart.items[].product.notes[].writerId | string | Optional | |
| cart.items[].product.notes[].writerName | string | Optional | |
| cart.items[].product.overrideMetrcCategoryId | string | Optional | |
| cart.items[].product.potency | boolean | Optional | |
| cart.items[].product.potencyAmount | object | PotencyMG | Optional |
| cart.items[].product.potencyAmount.cbd | number | Optional | |
| cart.items[].product.potencyAmount.cbda | number | Optional | |
| cart.items[].product.potencyAmount.cbn | number | Optional | |
| cart.items[].product.potencyAmount.thc | number | Optional | |
| cart.items[].product.potencyAmount.thca | number | Optional | |
| cart.items[].product.prepackageQuantities | object | Optional | |
| cart.items[].product.prepackageQuantities.<key> | map of object | PrepackageQuantity | Optional |
| cart.items[].product.prepackageQuantities.<key>.committedQuantities | object | Optional | |
| cart.items[].product.prepackageQuantities.<key>.committedQuantities.<key> | map of int32 | Optional | |
| cart.items[].product.prepackageQuantities.<key>.sellableQuantities | object | Optional | |
| cart.items[].product.prepackageQuantities.<key>.sellableQuantities.<key> | map of int32 | Optional | |
| cart.items[].product.prepackageQuantities.<key>.totalCommittedQuantity | int32 | Optional | |
| cart.items[].product.prepackageQuantities.<key>.totalSellableQuantity | int32 | Optional | |
| cart.items[].product.priceBreaks[] | array | Optional | |
| cart.items[].product.priceBreaks[].active | boolean | Optional | |
| cart.items[].product.priceBreaks[].assignedPrice | number | Optional | |
| cart.items[].product.priceBreaks[].companyId | string | Optional | |
| cart.items[].product.priceBreaks[].created | int64 | Optional | |
| cart.items[].product.priceBreaks[].deleted | boolean | Optional | |
| cart.items[].product.priceBreaks[].displayName | string | Optional | |
| cart.items[].product.priceBreaks[].id | string | Optional | |
| cart.items[].product.priceBreaks[].modified | int64 | Optional | |
| cart.items[].product.priceBreaks[].name | string | Optional | |
| cart.items[].product.priceBreaks[].price | number | Optional | |
| cart.items[].product.priceBreaks[].priceBreakType | string |
Possible values are:
|
Optional |
| cart.items[].product.priceBreaks[].priority | int32 | Optional | |
| cart.items[].product.priceBreaks[].quantity | int32 | Optional | |
| cart.items[].product.priceBreaks[].salePrice | number | Optional | |
| cart.items[].product.priceBreaks[].updated | boolean | Optional | |
| cart.items[].product.priceIncludesALExcise | boolean | Optional | |
| cart.items[].product.priceIncludesExcise | boolean | Optional | |
| cart.items[].product.priceRanges[] | array | Optional | |
| cart.items[].product.priceRanges[].assignedPrice | number | Optional | |
| cart.items[].product.priceRanges[].id | string | Optional | |
| cart.items[].product.priceRanges[].price | number | Optional | |
| cart.items[].product.priceRanges[].priority | int32 | Optional | |
| cart.items[].product.priceRanges[].salePrice | number | Optional | |
| cart.items[].product.priceRanges[].weightTolerance | object | ProductWeightTolerance | Optional |
| cart.items[].product.priceRanges[].weightTolerance.companyId | string | Optional | |
| cart.items[].product.priceRanges[].weightTolerance.created | int64 | Optional | |
| cart.items[].product.priceRanges[].weightTolerance.deleted | boolean | Optional | |
| cart.items[].product.priceRanges[].weightTolerance.enabled | boolean | Optional | |
| cart.items[].product.priceRanges[].weightTolerance.endWeight | number | Optional | |
| cart.items[].product.priceRanges[].weightTolerance.id | string | Optional | |
| cart.items[].product.priceRanges[].weightTolerance.modified | int64 | Optional | |
| cart.items[].product.priceRanges[].weightTolerance.name | string | Optional | |
| cart.items[].product.priceRanges[].weightTolerance.priority | int32 | Optional | |
| cart.items[].product.priceRanges[].weightTolerance.startWeight | number | Optional | |
| cart.items[].product.priceRanges[].weightTolerance.unitValue | number | Optional | |
| cart.items[].product.priceRanges[].weightTolerance.updated | boolean | Optional | |
| cart.items[].product.priceRanges[].weightTolerance.weightKey | string |
Possible values are:
|
Optional |
| cart.items[].product.priceRanges[].weightTolerance.weightValue | number | Optional | |
| cart.items[].product.priceRanges[].weightToleranceId | string | Optional | |
| cart.items[].product.pricingTemplateId | string | Optional | |
| cart.items[].product.producerAddress | object | Address | Optional |
| cart.items[].product.producerAddress.address | string | Optional | |
| cart.items[].product.producerAddress.addressLine2 | string | Optional | |
| cart.items[].product.producerAddress.city | string | Optional | |
| cart.items[].product.producerAddress.companyId | string | Optional | |
| cart.items[].product.producerAddress.country | string | Optional | |
| cart.items[].product.producerAddress.created | int64 | Optional | |
| cart.items[].product.producerAddress.deleted | boolean | Optional | |
| cart.items[].product.producerAddress.id | string | Optional | |
| cart.items[].product.producerAddress.latitude | number | Optional | |
| cart.items[].product.producerAddress.longitude | number | Optional | |
| cart.items[].product.producerAddress.modified | int64 | Optional | |
| cart.items[].product.producerAddress.state | string | Optional | |
| cart.items[].product.producerAddress.updated | boolean | Optional | |
| cart.items[].product.producerAddress.zipCode | string | Optional | |
| cart.items[].product.producerLicense | string | Optional | |
| cart.items[].product.producerMfg | string | Optional | |
| cart.items[].product.productSaleType | string |
Possible values are:
|
Optional |
| cart.items[].product.productType | string |
Possible values are:
|
Optional |
| cart.items[].product.qbItemRef | string | Optional | |
| cart.items[].product.quantities[] | array | Optional | |
| cart.items[].product.quantities[].companyId | string | Optional | |
| cart.items[].product.quantities[].created | int64 | Optional | |
| cart.items[].product.quantities[].deleted | boolean | Optional | |
| cart.items[].product.quantities[].dirty | boolean | Optional | |
| cart.items[].product.quantities[].id | string | Optional | |
| cart.items[].product.quantities[].inventoryId | string | Optional | |
| cart.items[].product.quantities[].modified | int64 | Optional | |
| cart.items[].product.quantities[].quantity | number | Optional | |
| cart.items[].product.quantities[].shopId | string | Optional | |
| cart.items[].product.quantities[].updated | boolean | Optional | |
| cart.items[].product.reOrderLevel | number | Optional | |
| cart.items[].product.salesPrice | number | Optional | |
| cart.items[].product.secondaryVendors[] | array of string | Optional | |
| cart.items[].product.sellable | boolean | Optional | |
| cart.items[].product.sellableQuantities | object | Optional | |
| cart.items[].product.sellableQuantities.<key> | map of number | Optional | |
| cart.items[].product.shopId | string | Optional | |
| cart.items[].product.showInWidget | boolean | Optional | |
| cart.items[].product.sku | string | Optional | |
| cart.items[].product.tags[] | array of string | Optional | |
| cart.items[].product.taxOrder | string |
Possible values are:
|
Optional |
| cart.items[].product.taxTables[] | array | Optional | |
| cart.items[].product.taxTables[].active | boolean | Optional | |
| cart.items[].product.taxTables[].cityTax | object | CompoundTaxRate | Optional |
| cart.items[].product.taxTables[].cityTax.active | boolean | Optional | |
| cart.items[].product.taxTables[].cityTax.activeExciseTax | boolean | Optional | |
| cart.items[].product.taxTables[].cityTax.companyId | string | Optional | |
| cart.items[].product.taxTables[].cityTax.compound | boolean | Optional | |
| cart.items[].product.taxTables[].cityTax.created | int64 | Optional | |
| cart.items[].product.taxTables[].cityTax.deleted | boolean | Optional | |
| cart.items[].product.taxTables[].cityTax.dirty | boolean | Optional | |
| cart.items[].product.taxTables[].cityTax.displayName | string | Optional | |
| cart.items[].product.taxTables[].cityTax.id | string | Optional | |
| cart.items[].product.taxTables[].cityTax.modified | int64 | Optional | |
| cart.items[].product.taxTables[].cityTax.shopId | string | Optional | |
| cart.items[].product.taxTables[].cityTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.items[].product.taxTables[].cityTax.taxRate | number | Optional | |
| cart.items[].product.taxTables[].cityTax.territory | string |
Possible values are:
|
Optional |
| cart.items[].product.taxTables[].cityTax.updated | boolean | Optional | |
| cart.items[].product.taxTables[].companyId | string | Optional | |
| cart.items[].product.taxTables[].consumerType | string |
Possible values are:
|
Optional |
| cart.items[].product.taxTables[].countyTax | object | CompoundTaxRate | Optional |
| cart.items[].product.taxTables[].countyTax.active | boolean | Optional | |
| cart.items[].product.taxTables[].countyTax.activeExciseTax | boolean | Optional | |
| cart.items[].product.taxTables[].countyTax.companyId | string | Optional | |
| cart.items[].product.taxTables[].countyTax.compound | boolean | Optional | |
| cart.items[].product.taxTables[].countyTax.created | int64 | Optional | |
| cart.items[].product.taxTables[].countyTax.deleted | boolean | Optional | |
| cart.items[].product.taxTables[].countyTax.dirty | boolean | Optional | |
| cart.items[].product.taxTables[].countyTax.displayName | string | Optional | |
| cart.items[].product.taxTables[].countyTax.id | string | Optional | |
| cart.items[].product.taxTables[].countyTax.modified | int64 | Optional | |
| cart.items[].product.taxTables[].countyTax.shopId | string | Optional | |
| cart.items[].product.taxTables[].countyTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.items[].product.taxTables[].countyTax.taxRate | number | Optional | |
| cart.items[].product.taxTables[].countyTax.territory | string |
Possible values are:
|
Optional |
| cart.items[].product.taxTables[].countyTax.updated | boolean | Optional | |
| cart.items[].product.taxTables[].created | int64 | Optional | |
| cart.items[].product.taxTables[].deleted | boolean | Optional | |
| cart.items[].product.taxTables[].dirty | boolean | Optional | |
| cart.items[].product.taxTables[].federalTax | object | CompoundTaxRate | Optional |
| cart.items[].product.taxTables[].federalTax.active | boolean | Optional | |
| cart.items[].product.taxTables[].federalTax.activeExciseTax | boolean | Optional | |
| cart.items[].product.taxTables[].federalTax.companyId | string | Optional | |
| cart.items[].product.taxTables[].federalTax.compound | boolean | Optional | |
| cart.items[].product.taxTables[].federalTax.created | int64 | Optional | |
| cart.items[].product.taxTables[].federalTax.deleted | boolean | Optional | |
| cart.items[].product.taxTables[].federalTax.dirty | boolean | Optional | |
| cart.items[].product.taxTables[].federalTax.displayName | string | Optional | |
| cart.items[].product.taxTables[].federalTax.id | string | Optional | |
| cart.items[].product.taxTables[].federalTax.modified | int64 | Optional | |
| cart.items[].product.taxTables[].federalTax.shopId | string | Optional | |
| cart.items[].product.taxTables[].federalTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.items[].product.taxTables[].federalTax.taxRate | number | Optional | |
| cart.items[].product.taxTables[].federalTax.territory | string |
Possible values are:
|
Optional |
| cart.items[].product.taxTables[].federalTax.updated | boolean | Optional | |
| cart.items[].product.taxTables[].id | string | Optional | |
| cart.items[].product.taxTables[].modified | int64 | Optional | |
| cart.items[].product.taxTables[].name | string | Optional | |
| cart.items[].product.taxTables[].shopId | string | Optional | |
| cart.items[].product.taxTables[].stateTax | object | CompoundTaxRate | Optional |
| cart.items[].product.taxTables[].stateTax.active | boolean | Optional | |
| cart.items[].product.taxTables[].stateTax.activeExciseTax | boolean | Optional | |
| cart.items[].product.taxTables[].stateTax.companyId | string | Optional | |
| cart.items[].product.taxTables[].stateTax.compound | boolean | Optional | |
| cart.items[].product.taxTables[].stateTax.created | int64 | Optional | |
| cart.items[].product.taxTables[].stateTax.deleted | boolean | Optional | |
| cart.items[].product.taxTables[].stateTax.dirty | boolean | Optional | |
| cart.items[].product.taxTables[].stateTax.displayName | string | Optional | |
| cart.items[].product.taxTables[].stateTax.id | string | Optional | |
| cart.items[].product.taxTables[].stateTax.modified | int64 | Optional | |
| cart.items[].product.taxTables[].stateTax.shopId | string | Optional | |
| cart.items[].product.taxTables[].stateTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.items[].product.taxTables[].stateTax.taxRate | number | Optional | |
| cart.items[].product.taxTables[].stateTax.territory | string |
Possible values are:
|
Optional |
| cart.items[].product.taxTables[].stateTax.updated | boolean | Optional | |
| cart.items[].product.taxTables[].taxOrder | string |
Possible values are:
|
Optional |
| cart.items[].product.taxTables[].taxType | string |
Possible values are:
|
Optional |
| cart.items[].product.taxTables[].updated | boolean | Optional | |
| cart.items[].product.taxType | string |
Possible values are:
|
Optional |
| cart.items[].product.thc | double | Optional | |
| cart.items[].product.thca | double | Optional | |
| cart.items[].product.toleranceId | string | Optional | |
| cart.items[].product.totalCommittedQuantity | number | Optional | |
| cart.items[].product.totalSellableQuantity | number | Optional | |
| cart.items[].product.unitPrice | number | Optional | |
| cart.items[].product.unitValue | number | Optional | |
| cart.items[].product.updated | boolean | Optional | |
| cart.items[].product.usableMarijuana | number | Optional | |
| cart.items[].product.vendor | object | Vendor | Optional |
| cart.items[].product.vendor.accountOwnerId | string | Optional | |
| cart.items[].product.vendor.active | boolean | Optional | |
| cart.items[].product.vendor.additionalAddressList[] | array | Optional | |
| cart.items[].product.vendor.additionalAddressList[].address | string | Optional | |
| cart.items[].product.vendor.additionalAddressList[].addressLine2 | string | Optional | |
| cart.items[].product.vendor.additionalAddressList[].city | string | Optional | |
| cart.items[].product.vendor.additionalAddressList[].companyId | string | Optional | |
| cart.items[].product.vendor.additionalAddressList[].country | string | Optional | |
| cart.items[].product.vendor.additionalAddressList[].created | int64 | Optional | |
| cart.items[].product.vendor.additionalAddressList[].deleted | boolean | Optional | |
| cart.items[].product.vendor.additionalAddressList[].id | string | Optional | |
| cart.items[].product.vendor.additionalAddressList[].latitude | number | Optional | |
| cart.items[].product.vendor.additionalAddressList[].longitude | number | Optional | |
| cart.items[].product.vendor.additionalAddressList[].modified | int64 | Optional | |
| cart.items[].product.vendor.additionalAddressList[].state | string | Optional | |
| cart.items[].product.vendor.additionalAddressList[].updated | boolean | Optional | |
| cart.items[].product.vendor.additionalAddressList[].zipCode | string | Optional | |
| cart.items[].product.vendor.address | object | Address | Optional |
| cart.items[].product.vendor.address.address | string | Optional | |
| cart.items[].product.vendor.address.addressLine2 | string | Optional | |
| cart.items[].product.vendor.address.city | string | Optional | |
| cart.items[].product.vendor.address.companyId | string | Optional | |
| cart.items[].product.vendor.address.country | string | Optional | |
| cart.items[].product.vendor.address.created | int64 | Optional | |
| cart.items[].product.vendor.address.deleted | boolean | Optional | |
| cart.items[].product.vendor.address.id | string | Optional | |
| cart.items[].product.vendor.address.latitude | number | Optional | |
| cart.items[].product.vendor.address.longitude | number | Optional | |
| cart.items[].product.vendor.address.modified | int64 | Optional | |
| cart.items[].product.vendor.address.state | string | Optional | |
| cart.items[].product.vendor.address.updated | boolean | Optional | |
| cart.items[].product.vendor.address.zipCode | string | Optional | |
| cart.items[].product.vendor.armsLengthType | string |
Possible values are:
|
Optional |
| cart.items[].product.vendor.assets[] | array | Optional | |
| cart.items[].product.vendor.assets[].active | boolean | Optional | |
| cart.items[].product.vendor.assets[].assetType | string |
Possible values are:
|
Optional |
| cart.items[].product.vendor.assets[].companyId | string | Optional | |
| cart.items[].product.vendor.assets[].created | int64 | Optional | |
| cart.items[].product.vendor.assets[].deleted | boolean | Optional | |
| cart.items[].product.vendor.assets[].id | string | Optional | |
| cart.items[].product.vendor.assets[].key | string | Optional | |
| cart.items[].product.vendor.assets[].largeURL | string | Optional | |
| cart.items[].product.vendor.assets[].largeX2URL | string | Optional | |
| cart.items[].product.vendor.assets[].mediumURL | string | Optional | |
| cart.items[].product.vendor.assets[].modified | int64 | Optional | |
| cart.items[].product.vendor.assets[].name | string | Optional | |
| cart.items[].product.vendor.assets[].origURL | string | Optional | |
| cart.items[].product.vendor.assets[].priority | int32 | Optional | |
| cart.items[].product.vendor.assets[].publicURL | string | Optional | |
| cart.items[].product.vendor.assets[].secured | boolean | Optional | |
| cart.items[].product.vendor.assets[].thumbURL | string | Optional | |
| cart.items[].product.vendor.assets[].type | string |
Possible values are:
|
Optional |
| cart.items[].product.vendor.assets[].updated | boolean | Optional | |
| cart.items[].product.vendor.backOrderEnabled | boolean | Optional | |
| cart.items[].product.vendor.brands[] | array of string | Optional | |
| cart.items[].product.vendor.companyId | string | Optional | |
| cart.items[].product.vendor.companyLicenses[] | array | Optional | |
| cart.items[].product.vendor.companyLicenses[].companyType | string |
Possible values are:
|
Optional |
| cart.items[].product.vendor.companyLicenses[].created | int64 | Optional | |
| cart.items[].product.vendor.companyLicenses[].deleted | boolean | Optional | |
| cart.items[].product.vendor.companyLicenses[].id | string | Optional | |
| cart.items[].product.vendor.companyLicenses[].licenseExpirationDate | int64 | Optional | |
| cart.items[].product.vendor.companyLicenses[].licenseNumber | string | Optional | |
| cart.items[].product.vendor.companyLicenses[].licenseType | string |
Possible values are:
|
Optional |
| cart.items[].product.vendor.companyLicenses[].modified | int64 | Optional | |
| cart.items[].product.vendor.companyLicenses[].toDefault | boolean | Optional | |
| cart.items[].product.vendor.companyLicenses[].updated | boolean | Optional | |
| cart.items[].product.vendor.companyType | string |
Possible values are:
|
Optional |
| cart.items[].product.vendor.connectedShop | string | Optional | |
| cart.items[].product.vendor.contactPerson | string | Optional | |
| cart.items[].product.vendor.created | int64 | Optional | |
| cart.items[].product.vendor.createdBy | string | Optional | |
| cart.items[].product.vendor.credits | number | Optional | |
| cart.items[].product.vendor.dbaName | string | Optional | |
| cart.items[].product.vendor.defaultContactId | string | Optional | |
| cart.items[].product.vendor.defaultPaymentTerm | string | Optional | |
| cart.items[].product.vendor.deleted | boolean | Optional | |
| cart.items[].product.vendor.description | string | Optional | |
| cart.items[].product.vendor.email | string | Optional | |
| cart.items[].product.vendor.externalId | string | Optional | |
| cart.items[].product.vendor.fax | string | Optional | |
| cart.items[].product.vendor.firstName | string | Optional | |
| cart.items[].product.vendor.id | string | Optional | |
| cart.items[].product.vendor.importId | string | Optional | |
| cart.items[].product.vendor.lastName | string | Optional | |
| cart.items[].product.vendor.licenceType | string |
Possible values are:
|
Optional |
| cart.items[].product.vendor.licenseExpirationDate | int64 | Optional | |
| cart.items[].product.vendor.licenseNumber | string | Optional | |
| cart.items[].product.vendor.mobileNumber | string | Optional | |
| cart.items[].product.vendor.modified | int64 | Optional | |
| cart.items[].product.vendor.name | string | Optional | |
| cart.items[].product.vendor.notes[] | array | Optional | |
| cart.items[].product.vendor.notes[].created | int64 | Optional | |
| cart.items[].product.vendor.notes[].deleted | boolean | Optional | |
| cart.items[].product.vendor.notes[].enableOnFleet | boolean | Optional | |
| cart.items[].product.vendor.notes[].id | string | Optional | |
| cart.items[].product.vendor.notes[].message | string | Optional | |
| cart.items[].product.vendor.notes[].modified | int64 | Optional | |
| cart.items[].product.vendor.notes[].updated | boolean | Optional | |
| cart.items[].product.vendor.notes[].writerId | string | Optional | |
| cart.items[].product.vendor.notes[].writerName | string | Optional | |
| cart.items[].product.vendor.phone | string | Optional | |
| cart.items[].product.vendor.qbVendorRef[] | array of object | Optional | |
| cart.items[].product.vendor.qbVendorRef[].<key> | map of string | Optional | |
| cart.items[].product.vendor.relatedEntity | boolean | Optional | |
| cart.items[].product.vendor.salesPerson | string | Optional | |
| cart.items[].product.vendor.toDefault | boolean | Optional | |
| cart.items[].product.vendor.updated | boolean | Optional | |
| cart.items[].product.vendor.vendorType | string |
Possible values are:
|
Optional |
| cart.items[].product.vendor.website | string | Optional | |
| cart.items[].product.vendorId | string | Optional | |
| cart.items[].product.weightPerUnit | string |
Possible values are:
|
Optional |
| cart.items[].product.wmOnlineSellable | boolean | Optional | |
| cart.items[].product.wmThreshold | number | Optional | |
| cart.items[].productId | string | Optional | |
| cart.items[].promotionReqs[] | array | Optional | |
| cart.items[].promotionReqs[].assigned | boolean | Optional | |
| cart.items[].promotionReqs[].companyId | string | Optional | |
| cart.items[].promotionReqs[].created | int64 | Optional | |
| cart.items[].promotionReqs[].deleted | boolean | Optional | |
| cart.items[].promotionReqs[].finalizedDiscountId | string | Optional | |
| cart.items[].promotionReqs[].id | string | Optional | |
| cart.items[].promotionReqs[].modified | int64 | Optional | |
| cart.items[].promotionReqs[].promotionId | string | Optional | |
| cart.items[].promotionReqs[].rewardId | string | Optional | |
| cart.items[].promotionReqs[].updated | boolean | Optional | |
| cart.items[].quantity | number | Optional | |
| cart.items[].quantityLogs[] | array | Optional | |
| cart.items[].quantityLogs[].batchId | string | Optional | |
| cart.items[].quantityLogs[].id | string | Optional | |
| cart.items[].quantityLogs[].inventoryId | string | Optional | |
| cart.items[].quantityLogs[].packageLabel | string | Optional | |
| cart.items[].quantityLogs[].prepackageItemId | string | Optional | |
| cart.items[].quantityLogs[].quantity | number | Optional | |
| cart.items[].remarks | string | Optional | |
| cart.items[].status | string |
Possible values are:
|
Optional |
| cart.items[].taxInfo | object | TaxInfo | Optional |
| cart.items[].taxInfo.cityTax | number | Optional | |
| cart.items[].taxInfo.created | int64 | Optional | |
| cart.items[].taxInfo.deleted | boolean | Optional | |
| cart.items[].taxInfo.federalTax | number | Optional | |
| cart.items[].taxInfo.id | string | Optional | |
| cart.items[].taxInfo.modified | int64 | Optional | |
| cart.items[].taxInfo.stateTax | number | Optional | |
| cart.items[].taxInfo.updated | boolean | Optional | |
| cart.items[].taxOrder | string |
Possible values are:
|
Optional |
| cart.items[].taxResult | object | TaxResult | Optional |
| cart.items[].taxResult.created | int64 | Optional | |
| cart.items[].taxResult.cultivationTaxResult | object | CultivationTaxResult | Optional |
| cart.items[].taxResult.cultivationTaxResult.flowerTaxOz | number | Optional | |
| cart.items[].taxResult.cultivationTaxResult.leafTaxOz | number | Optional | |
| cart.items[].taxResult.cultivationTaxResult.plantTaxOz | number | Optional | |
| cart.items[].taxResult.cultivationTaxResult.totalCultivationTax | number | Optional | |
| cart.items[].taxResult.cultivationTaxResult.totalFlowerOz | number | Optional | |
| cart.items[].taxResult.cultivationTaxResult.totalFlowerTax | number | Optional | |
| cart.items[].taxResult.cultivationTaxResult.totalLeafOz | number | Optional | |
| cart.items[].taxResult.cultivationTaxResult.totalLeafTax | number | Optional | |
| cart.items[].taxResult.cultivationTaxResult.totalPlantOz | number | Optional | |
| cart.items[].taxResult.cultivationTaxResult.totalPlantTax | number | Optional | |
| cart.items[].taxResult.deleted | boolean | Optional | |
| cart.items[].taxResult.id | string | Optional | |
| cart.items[].taxResult.modified | int64 | Optional | |
| cart.items[].taxResult.taxMappingInfo | object | Optional | |
| cart.items[].taxResult.taxMappingInfo.<key> | map of string | Optional | |
| cart.items[].taxResult.totalALExciseTax | number | Optional | |
| cart.items[].taxResult.totalALPostExciseTax | number | Optional | |
| cart.items[].taxResult.totalCityPreTax | number | Optional | |
| cart.items[].taxResult.totalCityTax | number | Optional | |
| cart.items[].taxResult.totalCountyPreTax | number | Optional | |
| cart.items[].taxResult.totalCountyTax | number | Optional | |
| cart.items[].taxResult.totalExciseTax | number | Optional | |
| cart.items[].taxResult.totalFedPreTax | number | Optional | |
| cart.items[].taxResult.totalFedTax | number | Optional | |
| cart.items[].taxResult.totalNALPreExciseTax | number | Optional | |
| cart.items[].taxResult.totalPostCalcTax | number | Optional | |
| cart.items[].taxResult.totalPreCalcTax | number | Optional | |
| cart.items[].taxResult.totalStatePreTax | number | Optional | |
| cart.items[].taxResult.totalStateTax | number | Optional | |
| cart.items[].taxResult.updated | boolean | Optional | |
| cart.items[].taxTable | object | CompoundTaxTable | Optional |
| cart.items[].taxTable.active | boolean | Optional | |
| cart.items[].taxTable.cityTax | object | CompoundTaxRate | Optional |
| cart.items[].taxTable.cityTax.active | boolean | Optional | |
| cart.items[].taxTable.cityTax.activeExciseTax | boolean | Optional | |
| cart.items[].taxTable.cityTax.companyId | string | Optional | |
| cart.items[].taxTable.cityTax.compound | boolean | Optional | |
| cart.items[].taxTable.cityTax.created | int64 | Optional | |
| cart.items[].taxTable.cityTax.deleted | boolean | Optional | |
| cart.items[].taxTable.cityTax.dirty | boolean | Optional | |
| cart.items[].taxTable.cityTax.displayName | string | Optional | |
| cart.items[].taxTable.cityTax.id | string | Optional | |
| cart.items[].taxTable.cityTax.modified | int64 | Optional | |
| cart.items[].taxTable.cityTax.shopId | string | Optional | |
| cart.items[].taxTable.cityTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.items[].taxTable.cityTax.taxRate | number | Optional | |
| cart.items[].taxTable.cityTax.territory | string |
Possible values are:
|
Optional |
| cart.items[].taxTable.cityTax.updated | boolean | Optional | |
| cart.items[].taxTable.companyId | string | Optional | |
| cart.items[].taxTable.consumerType | string |
Possible values are:
|
Optional |
| cart.items[].taxTable.countyTax | object | CompoundTaxRate | Optional |
| cart.items[].taxTable.countyTax.active | boolean | Optional | |
| cart.items[].taxTable.countyTax.activeExciseTax | boolean | Optional | |
| cart.items[].taxTable.countyTax.companyId | string | Optional | |
| cart.items[].taxTable.countyTax.compound | boolean | Optional | |
| cart.items[].taxTable.countyTax.created | int64 | Optional | |
| cart.items[].taxTable.countyTax.deleted | boolean | Optional | |
| cart.items[].taxTable.countyTax.dirty | boolean | Optional | |
| cart.items[].taxTable.countyTax.displayName | string | Optional | |
| cart.items[].taxTable.countyTax.id | string | Optional | |
| cart.items[].taxTable.countyTax.modified | int64 | Optional | |
| cart.items[].taxTable.countyTax.shopId | string | Optional | |
| cart.items[].taxTable.countyTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.items[].taxTable.countyTax.taxRate | number | Optional | |
| cart.items[].taxTable.countyTax.territory | string |
Possible values are:
|
Optional |
| cart.items[].taxTable.countyTax.updated | boolean | Optional | |
| cart.items[].taxTable.created | int64 | Optional | |
| cart.items[].taxTable.deleted | boolean | Optional | |
| cart.items[].taxTable.dirty | boolean | Optional | |
| cart.items[].taxTable.federalTax | object | CompoundTaxRate | Optional |
| cart.items[].taxTable.federalTax.active | boolean | Optional | |
| cart.items[].taxTable.federalTax.activeExciseTax | boolean | Optional | |
| cart.items[].taxTable.federalTax.companyId | string | Optional | |
| cart.items[].taxTable.federalTax.compound | boolean | Optional | |
| cart.items[].taxTable.federalTax.created | int64 | Optional | |
| cart.items[].taxTable.federalTax.deleted | boolean | Optional | |
| cart.items[].taxTable.federalTax.dirty | boolean | Optional | |
| cart.items[].taxTable.federalTax.displayName | string | Optional | |
| cart.items[].taxTable.federalTax.id | string | Optional | |
| cart.items[].taxTable.federalTax.modified | int64 | Optional | |
| cart.items[].taxTable.federalTax.shopId | string | Optional | |
| cart.items[].taxTable.federalTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.items[].taxTable.federalTax.taxRate | number | Optional | |
| cart.items[].taxTable.federalTax.territory | string |
Possible values are:
|
Optional |
| cart.items[].taxTable.federalTax.updated | boolean | Optional | |
| cart.items[].taxTable.id | string | Optional | |
| cart.items[].taxTable.modified | int64 | Optional | |
| cart.items[].taxTable.name | string | Optional | |
| cart.items[].taxTable.shopId | string | Optional | |
| cart.items[].taxTable.stateTax | object | CompoundTaxRate | Optional |
| cart.items[].taxTable.stateTax.active | boolean | Optional | |
| cart.items[].taxTable.stateTax.activeExciseTax | boolean | Optional | |
| cart.items[].taxTable.stateTax.companyId | string | Optional | |
| cart.items[].taxTable.stateTax.compound | boolean | Optional | |
| cart.items[].taxTable.stateTax.created | int64 | Optional | |
| cart.items[].taxTable.stateTax.deleted | boolean | Optional | |
| cart.items[].taxTable.stateTax.dirty | boolean | Optional | |
| cart.items[].taxTable.stateTax.displayName | string | Optional | |
| cart.items[].taxTable.stateTax.id | string | Optional | |
| cart.items[].taxTable.stateTax.modified | int64 | Optional | |
| cart.items[].taxTable.stateTax.shopId | string | Optional | |
| cart.items[].taxTable.stateTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.items[].taxTable.stateTax.taxRate | number | Optional | |
| cart.items[].taxTable.stateTax.territory | string |
Possible values are:
|
Optional |
| cart.items[].taxTable.stateTax.updated | boolean | Optional | |
| cart.items[].taxTable.taxOrder | string |
Possible values are:
|
Optional |
| cart.items[].taxTable.taxType | string |
Possible values are:
|
Optional |
| cart.items[].taxTable.updated | boolean | Optional | |
| cart.items[].taxType | string |
Possible values are:
|
Optional |
| cart.items[].totalRefundAmount | number | Optional | |
| cart.items[].totalRefundQty | number | Optional | |
| cart.items[].txnLineID | string | Optional | |
| cart.items[].txnLineIDMap | object | Optional | |
| cart.items[].txnLineIDMap.<key> | map of string | Optional | |
| cart.items[].unitPrice | number | Optional | |
| cart.items[].unitQty | int32 | Optional | |
| cart.items[].updated | boolean | Optional | |
| cart.items[].useUnitQty | boolean | Optional | |
| cart.items[].weightKey | string |
Possible values are:
|
Optional |
| cart.lastCreditCardFee | number | Optional | |
| cart.modified | int64 | Optional | |
| cart.nonCannabisTaxTable | object | CompoundTaxTable | Optional |
| cart.nonCannabisTaxTable.active | boolean | Optional | |
| cart.nonCannabisTaxTable.cityTax | object | CompoundTaxRate | Optional |
| cart.nonCannabisTaxTable.cityTax.active | boolean | Optional | |
| cart.nonCannabisTaxTable.cityTax.activeExciseTax | boolean | Optional | |
| cart.nonCannabisTaxTable.cityTax.companyId | string | Optional | |
| cart.nonCannabisTaxTable.cityTax.compound | boolean | Optional | |
| cart.nonCannabisTaxTable.cityTax.created | int64 | Optional | |
| cart.nonCannabisTaxTable.cityTax.deleted | boolean | Optional | |
| cart.nonCannabisTaxTable.cityTax.dirty | boolean | Optional | |
| cart.nonCannabisTaxTable.cityTax.displayName | string | Optional | |
| cart.nonCannabisTaxTable.cityTax.id | string | Optional | |
| cart.nonCannabisTaxTable.cityTax.modified | int64 | Optional | |
| cart.nonCannabisTaxTable.cityTax.shopId | string | Optional | |
| cart.nonCannabisTaxTable.cityTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.nonCannabisTaxTable.cityTax.taxRate | number | Optional | |
| cart.nonCannabisTaxTable.cityTax.territory | string |
Possible values are:
|
Optional |
| cart.nonCannabisTaxTable.cityTax.updated | boolean | Optional | |
| cart.nonCannabisTaxTable.companyId | string | Optional | |
| cart.nonCannabisTaxTable.consumerType | string |
Possible values are:
|
Optional |
| cart.nonCannabisTaxTable.countyTax | object | CompoundTaxRate | Optional |
| cart.nonCannabisTaxTable.countyTax.active | boolean | Optional | |
| cart.nonCannabisTaxTable.countyTax.activeExciseTax | boolean | Optional | |
| cart.nonCannabisTaxTable.countyTax.companyId | string | Optional | |
| cart.nonCannabisTaxTable.countyTax.compound | boolean | Optional | |
| cart.nonCannabisTaxTable.countyTax.created | int64 | Optional | |
| cart.nonCannabisTaxTable.countyTax.deleted | boolean | Optional | |
| cart.nonCannabisTaxTable.countyTax.dirty | boolean | Optional | |
| cart.nonCannabisTaxTable.countyTax.displayName | string | Optional | |
| cart.nonCannabisTaxTable.countyTax.id | string | Optional | |
| cart.nonCannabisTaxTable.countyTax.modified | int64 | Optional | |
| cart.nonCannabisTaxTable.countyTax.shopId | string | Optional | |
| cart.nonCannabisTaxTable.countyTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.nonCannabisTaxTable.countyTax.taxRate | number | Optional | |
| cart.nonCannabisTaxTable.countyTax.territory | string |
Possible values are:
|
Optional |
| cart.nonCannabisTaxTable.countyTax.updated | boolean | Optional | |
| cart.nonCannabisTaxTable.created | int64 | Optional | |
| cart.nonCannabisTaxTable.deleted | boolean | Optional | |
| cart.nonCannabisTaxTable.dirty | boolean | Optional | |
| cart.nonCannabisTaxTable.federalTax | object | CompoundTaxRate | Optional |
| cart.nonCannabisTaxTable.federalTax.active | boolean | Optional | |
| cart.nonCannabisTaxTable.federalTax.activeExciseTax | boolean | Optional | |
| cart.nonCannabisTaxTable.federalTax.companyId | string | Optional | |
| cart.nonCannabisTaxTable.federalTax.compound | boolean | Optional | |
| cart.nonCannabisTaxTable.federalTax.created | int64 | Optional | |
| cart.nonCannabisTaxTable.federalTax.deleted | boolean | Optional | |
| cart.nonCannabisTaxTable.federalTax.dirty | boolean | Optional | |
| cart.nonCannabisTaxTable.federalTax.displayName | string | Optional | |
| cart.nonCannabisTaxTable.federalTax.id | string | Optional | |
| cart.nonCannabisTaxTable.federalTax.modified | int64 | Optional | |
| cart.nonCannabisTaxTable.federalTax.shopId | string | Optional | |
| cart.nonCannabisTaxTable.federalTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.nonCannabisTaxTable.federalTax.taxRate | number | Optional | |
| cart.nonCannabisTaxTable.federalTax.territory | string |
Possible values are:
|
Optional |
| cart.nonCannabisTaxTable.federalTax.updated | boolean | Optional | |
| cart.nonCannabisTaxTable.id | string | Optional | |
| cart.nonCannabisTaxTable.modified | int64 | Optional | |
| cart.nonCannabisTaxTable.name | string | Optional | |
| cart.nonCannabisTaxTable.shopId | string | Optional | |
| cart.nonCannabisTaxTable.stateTax | object | CompoundTaxRate | Optional |
| cart.nonCannabisTaxTable.stateTax.active | boolean | Optional | |
| cart.nonCannabisTaxTable.stateTax.activeExciseTax | boolean | Optional | |
| cart.nonCannabisTaxTable.stateTax.companyId | string | Optional | |
| cart.nonCannabisTaxTable.stateTax.compound | boolean | Optional | |
| cart.nonCannabisTaxTable.stateTax.created | int64 | Optional | |
| cart.nonCannabisTaxTable.stateTax.deleted | boolean | Optional | |
| cart.nonCannabisTaxTable.stateTax.dirty | boolean | Optional | |
| cart.nonCannabisTaxTable.stateTax.displayName | string | Optional | |
| cart.nonCannabisTaxTable.stateTax.id | string | Optional | |
| cart.nonCannabisTaxTable.stateTax.modified | int64 | Optional | |
| cart.nonCannabisTaxTable.stateTax.shopId | string | Optional | |
| cart.nonCannabisTaxTable.stateTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.nonCannabisTaxTable.stateTax.taxRate | number | Optional | |
| cart.nonCannabisTaxTable.stateTax.territory | string |
Possible values are:
|
Optional |
| cart.nonCannabisTaxTable.stateTax.updated | boolean | Optional | |
| cart.nonCannabisTaxTable.taxOrder | string |
Possible values are:
|
Optional |
| cart.nonCannabisTaxTable.taxType | string |
Possible values are:
|
Optional |
| cart.nonCannabisTaxTable.updated | boolean | Optional | |
| cart.paymentOption | string |
Possible values are:
|
Optional |
| cart.paymentType | string |
Possible values are:
|
Optional |
| cart.pointSpent | number | Optional | |
| cart.promoCode | string | Optional | |
| cart.promotionReqLogs[] | array | Optional | |
| cart.promotionReqLogs[].amount | number | Optional | |
| cart.promotionReqLogs[].assigned | boolean | Optional | |
| cart.promotionReqLogs[].companyId | string | Optional | |
| cart.promotionReqLogs[].created | int64 | Optional | |
| cart.promotionReqLogs[].deleted | boolean | Optional | |
| cart.promotionReqLogs[].finalizedDiscountId | string | Optional | |
| cart.promotionReqLogs[].id | string | Optional | |
| cart.promotionReqLogs[].modified | int64 | Optional | |
| cart.promotionReqLogs[].promotionId | string | Optional | |
| cart.promotionReqLogs[].promotionType | string |
Possible values are:
|
Optional |
| cart.promotionReqLogs[].rewardId | string | Optional | |
| cart.promotionReqLogs[].stackable | boolean | Optional | |
| cart.promotionReqLogs[].updated | boolean | Optional | |
| cart.promotionReqs[] | array | Optional | |
| cart.promotionReqs[].assigned | boolean | Optional | |
| cart.promotionReqs[].companyId | string | Optional | |
| cart.promotionReqs[].created | int64 | Optional | |
| cart.promotionReqs[].deleted | boolean | Optional | |
| cart.promotionReqs[].finalizedDiscountId | string | Optional | |
| cart.promotionReqs[].id | string | Optional | |
| cart.promotionReqs[].modified | int64 | Optional | |
| cart.promotionReqs[].promotionId | string | Optional | |
| cart.promotionReqs[].rewardId | string | Optional | |
| cart.promotionReqs[].updated | boolean | Optional | |
| cart.refundAmount | number | Optional | |
| cart.refundOption | string |
Possible values are:
|
Optional |
| cart.refundOrderItemRequests[] | array | Optional | |
| cart.refundOrderItemRequests[].created | int64 | Optional | |
| cart.refundOrderItemRequests[].createdById | string | Optional | |
| cart.refundOrderItemRequests[].createdUser | string | Optional | |
| cart.refundOrderItemRequests[].note | string | Optional | |
| cart.refundOrderItemRequests[].orderItemId | string | Optional | |
| cart.refundOrderItemRequests[].quantity | number | Optional | |
| cart.refundOrderItemRequests[].refundAmt | number | Optional | |
| cart.refundOrderItemRequests[].refundAs | string |
Possible values are:
|
Optional |
| cart.refundOrderItemRequests[].refundType | string |
Possible values are:
|
Optional |
| cart.refundOrderItemRequests[].withInventory | boolean | Optional | |
| cart.requestRefundAmt | number | Optional | |
| cart.roundAmt | number | Optional | |
| cart.splitPayment | object | SplitPayment | Optional |
| cart.splitPayment.cashAmt | number | Optional | |
| cart.splitPayment.cashlessAmt | number | Optional | |
| cart.splitPayment.checkAmt | number | Optional | |
| cart.splitPayment.companyId | string | Optional | |
| cart.splitPayment.created | int64 | Optional | |
| cart.splitPayment.creditDebitAmt | number | Optional | |
| cart.splitPayment.deleted | boolean | Optional | |
| cart.splitPayment.id | string | Optional | |
| cart.splitPayment.modified | int64 | Optional | |
| cart.splitPayment.storeCreditAmt | number | Optional | |
| cart.splitPayment.totalSplits | number | Optional | |
| cart.splitPayment.updated | boolean | Optional | |
| cart.storageLocation | string |
Possible values are:
|
Optional |
| cart.subTotal | number | Optional | |
| cart.subTotalDiscount | number | Optional | |
| cart.tax | number | Optional | |
| cart.taxResult | object | TaxResult | Optional |
| cart.taxResult.created | int64 | Optional | |
| cart.taxResult.cultivationTaxResult | object | CultivationTaxResult | Optional |
| cart.taxResult.cultivationTaxResult.flowerTaxOz | number | Optional | |
| cart.taxResult.cultivationTaxResult.leafTaxOz | number | Optional | |
| cart.taxResult.cultivationTaxResult.plantTaxOz | number | Optional | |
| cart.taxResult.cultivationTaxResult.totalCultivationTax | number | Optional | |
| cart.taxResult.cultivationTaxResult.totalFlowerOz | number | Optional | |
| cart.taxResult.cultivationTaxResult.totalFlowerTax | number | Optional | |
| cart.taxResult.cultivationTaxResult.totalLeafOz | number | Optional | |
| cart.taxResult.cultivationTaxResult.totalLeafTax | number | Optional | |
| cart.taxResult.cultivationTaxResult.totalPlantOz | number | Optional | |
| cart.taxResult.cultivationTaxResult.totalPlantTax | number | Optional | |
| cart.taxResult.deleted | boolean | Optional | |
| cart.taxResult.id | string | Optional | |
| cart.taxResult.modified | int64 | Optional | |
| cart.taxResult.taxMappingInfo | object | Optional | |
| cart.taxResult.taxMappingInfo.<key> | map of string | Optional | |
| cart.taxResult.totalALExciseTax | number | Optional | |
| cart.taxResult.totalALPostExciseTax | number | Optional | |
| cart.taxResult.totalCityPreTax | number | Optional | |
| cart.taxResult.totalCityTax | number | Optional | |
| cart.taxResult.totalCountyPreTax | number | Optional | |
| cart.taxResult.totalCountyTax | number | Optional | |
| cart.taxResult.totalExciseTax | number | Optional | |
| cart.taxResult.totalFedPreTax | number | Optional | |
| cart.taxResult.totalFedTax | number | Optional | |
| cart.taxResult.totalNALPreExciseTax | number | Optional | |
| cart.taxResult.totalPostCalcTax | number | Optional | |
| cart.taxResult.totalPreCalcTax | number | Optional | |
| cart.taxResult.totalStatePreTax | number | Optional | |
| cart.taxResult.totalStateTax | number | Optional | |
| cart.taxResult.updated | boolean | Optional | |
| cart.taxRoundOffType | string |
Possible values are:
|
Optional |
| cart.taxTable | object | CompoundTaxTable | Optional |
| cart.taxTable.active | boolean | Optional | |
| cart.taxTable.cityTax | object | CompoundTaxRate | Optional |
| cart.taxTable.cityTax.active | boolean | Optional | |
| cart.taxTable.cityTax.activeExciseTax | boolean | Optional | |
| cart.taxTable.cityTax.companyId | string | Optional | |
| cart.taxTable.cityTax.compound | boolean | Optional | |
| cart.taxTable.cityTax.created | int64 | Optional | |
| cart.taxTable.cityTax.deleted | boolean | Optional | |
| cart.taxTable.cityTax.dirty | boolean | Optional | |
| cart.taxTable.cityTax.displayName | string | Optional | |
| cart.taxTable.cityTax.id | string | Optional | |
| cart.taxTable.cityTax.modified | int64 | Optional | |
| cart.taxTable.cityTax.shopId | string | Optional | |
| cart.taxTable.cityTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.taxTable.cityTax.taxRate | number | Optional | |
| cart.taxTable.cityTax.territory | string |
Possible values are:
|
Optional |
| cart.taxTable.cityTax.updated | boolean | Optional | |
| cart.taxTable.companyId | string | Optional | |
| cart.taxTable.consumerType | string |
Possible values are:
|
Optional |
| cart.taxTable.countyTax | object | CompoundTaxRate | Optional |
| cart.taxTable.countyTax.active | boolean | Optional | |
| cart.taxTable.countyTax.activeExciseTax | boolean | Optional | |
| cart.taxTable.countyTax.companyId | string | Optional | |
| cart.taxTable.countyTax.compound | boolean | Optional | |
| cart.taxTable.countyTax.created | int64 | Optional | |
| cart.taxTable.countyTax.deleted | boolean | Optional | |
| cart.taxTable.countyTax.dirty | boolean | Optional | |
| cart.taxTable.countyTax.displayName | string | Optional | |
| cart.taxTable.countyTax.id | string | Optional | |
| cart.taxTable.countyTax.modified | int64 | Optional | |
| cart.taxTable.countyTax.shopId | string | Optional | |
| cart.taxTable.countyTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.taxTable.countyTax.taxRate | number | Optional | |
| cart.taxTable.countyTax.territory | string |
Possible values are:
|
Optional |
| cart.taxTable.countyTax.updated | boolean | Optional | |
| cart.taxTable.created | int64 | Optional | |
| cart.taxTable.deleted | boolean | Optional | |
| cart.taxTable.dirty | boolean | Optional | |
| cart.taxTable.federalTax | object | CompoundTaxRate | Optional |
| cart.taxTable.federalTax.active | boolean | Optional | |
| cart.taxTable.federalTax.activeExciseTax | boolean | Optional | |
| cart.taxTable.federalTax.companyId | string | Optional | |
| cart.taxTable.federalTax.compound | boolean | Optional | |
| cart.taxTable.federalTax.created | int64 | Optional | |
| cart.taxTable.federalTax.deleted | boolean | Optional | |
| cart.taxTable.federalTax.dirty | boolean | Optional | |
| cart.taxTable.federalTax.displayName | string | Optional | |
| cart.taxTable.federalTax.id | string | Optional | |
| cart.taxTable.federalTax.modified | int64 | Optional | |
| cart.taxTable.federalTax.shopId | string | Optional | |
| cart.taxTable.federalTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.taxTable.federalTax.taxRate | number | Optional | |
| cart.taxTable.federalTax.territory | string |
Possible values are:
|
Optional |
| cart.taxTable.federalTax.updated | boolean | Optional | |
| cart.taxTable.id | string | Optional | |
| cart.taxTable.modified | int64 | Optional | |
| cart.taxTable.name | string | Optional | |
| cart.taxTable.shopId | string | Optional | |
| cart.taxTable.stateTax | object | CompoundTaxRate | Optional |
| cart.taxTable.stateTax.active | boolean | Optional | |
| cart.taxTable.stateTax.activeExciseTax | boolean | Optional | |
| cart.taxTable.stateTax.companyId | string | Optional | |
| cart.taxTable.stateTax.compound | boolean | Optional | |
| cart.taxTable.stateTax.created | int64 | Optional | |
| cart.taxTable.stateTax.deleted | boolean | Optional | |
| cart.taxTable.stateTax.dirty | boolean | Optional | |
| cart.taxTable.stateTax.displayName | string | Optional | |
| cart.taxTable.stateTax.id | string | Optional | |
| cart.taxTable.stateTax.modified | int64 | Optional | |
| cart.taxTable.stateTax.shopId | string | Optional | |
| cart.taxTable.stateTax.taxOrder | string |
Possible values are:
|
Optional |
| cart.taxTable.stateTax.taxRate | number | Optional | |
| cart.taxTable.stateTax.territory | string |
Possible values are:
|
Optional |
| cart.taxTable.stateTax.updated | boolean | Optional | |
| cart.taxTable.taxOrder | string |
Possible values are:
|
Optional |
| cart.taxTable.taxType | string |
Possible values are:
|
Optional |
| cart.taxTable.updated | boolean | Optional | |
| cart.tipAmount | number | Optional | |
| cart.total | number | Optional | |
| cart.totalALExciseTax | number | Optional | |
| cart.totalCalcTax | number | Optional | |
| cart.totalDiscount | number | Optional | |
| cart.totalExciseTax | number | Optional | |
| cart.totalFees | number | Optional | |
| cart.totalPreCalcTax | number | Optional | |
| cart.updated | boolean | Optional | |
| checkinTime | int64 | Optional | |
| checkoutType | string |
Possible values are:
|
Optional |
| companyId | string | Optional | |
| completeAfter | int64 | Optional | |
| completedTime | int64 | Optional | |
| consumerCartId | string | Optional | |
| createOnfleetTask | boolean | Optional | |
| createTookanTask | boolean | Optional | |
| created | int64 | Optional | |
| createdByEmployee | object | Employee | Optional |
| createdByEmployee.address | object | Address | Optional |
| createdByEmployee.address.address | string | Optional | |
| createdByEmployee.address.addressLine2 | string | Optional | |
| createdByEmployee.address.city | string | Optional | |
| createdByEmployee.address.companyId | string | Optional | |
| createdByEmployee.address.country | string | Optional | |
| createdByEmployee.address.created | int64 | Optional | |
| createdByEmployee.address.deleted | boolean | Optional | |
| createdByEmployee.address.id | string | Optional | |
| createdByEmployee.address.latitude | number | Optional | |
| createdByEmployee.address.longitude | number | Optional | |
| createdByEmployee.address.modified | int64 | Optional | |
| createdByEmployee.address.state | string | Optional | |
| createdByEmployee.address.updated | boolean | Optional | |
| createdByEmployee.address.zipCode | string | Optional | |
| createdByEmployee.appAccessList[] | array of string |
Possible values are:
|
Optional |
| createdByEmployee.assignedInventoryId | string | Optional | |
| createdByEmployee.assignedTerminalId | string | Optional | |
| createdByEmployee.canApplyCustomDiscount | boolean | Optional | |
| createdByEmployee.cashDrawerStatus | string |
Possible values are:
|
Optional |
| createdByEmployee.companyId | string | Optional | |
| createdByEmployee.created | int64 | Optional | |
| createdByEmployee.deleted | boolean | Optional | |
| createdByEmployee.disabled | boolean | Optional | |
| createdByEmployee.dlExpirationDate | string | Optional | |
| createdByEmployee.driver | boolean | Optional | |
| createdByEmployee.driversLicense | string | Optional | |
| createdByEmployee.email | string | Optional | |
| createdByEmployee.employeeOnFleetInfoList[] | array | Optional | |
| createdByEmployee.employeeOnFleetInfoList[].onFleetTeamList[] | array of string | Optional | |
| createdByEmployee.employeeOnFleetInfoList[].onFleetWorkerId | string | Optional | |
| createdByEmployee.employeeOnFleetInfoList[].shopId | string | Optional | |
| createdByEmployee.externalId | string | Optional | |
| createdByEmployee.firstName | string | Optional | |
| createdByEmployee.id | string | Optional | |
| createdByEmployee.insuranceCompanyName | string | Optional | |
| createdByEmployee.insuranceExpireDate | int64 | Optional | |
| createdByEmployee.inventoryName | string | Optional | |
| createdByEmployee.lastLoggedInShopId | string | Optional | |
| createdByEmployee.lastLoginTime | int64 | Optional | |
| createdByEmployee.lastName | string | Optional | |
| createdByEmployee.modified | int64 | Optional | |
| createdByEmployee.notes[] | array | Optional | |
| createdByEmployee.notes[].created | int64 | Optional | |
| createdByEmployee.notes[].deleted | boolean | Optional | |
| createdByEmployee.notes[].enableOnFleet | boolean | Optional | |
| createdByEmployee.notes[].id | string | Optional | |
| createdByEmployee.notes[].message | string | Optional | |
| createdByEmployee.notes[].modified | int64 | Optional | |
| createdByEmployee.notes[].updated | boolean | Optional | |
| createdByEmployee.notes[].writerId | string | Optional | |
| createdByEmployee.notes[].writerName | string | Optional | |
| createdByEmployee.occupationLicenseNumber | string | Optional | |
| createdByEmployee.organizationIds[] | array of string | Optional | |
| createdByEmployee.password | string | Optional | |
| createdByEmployee.phoneNumber | string | Optional | |
| createdByEmployee.pin | string | Optional | |
| createdByEmployee.policyNumber | string | Optional | |
| createdByEmployee.recentLocation | object | TerminalLocation | Optional |
| createdByEmployee.recentLocation.companyId | string | Optional | |
| createdByEmployee.recentLocation.created | int64 | Optional | |
| createdByEmployee.recentLocation.deleted | boolean | Optional | |
| createdByEmployee.recentLocation.deviceId | string | Optional | |
| createdByEmployee.recentLocation.dirty | boolean | Optional | |
| createdByEmployee.recentLocation.employeeId | string | Optional | |
| createdByEmployee.recentLocation.id | string | Optional | |
| createdByEmployee.recentLocation.loc[] | array of double | Optional | |
| createdByEmployee.recentLocation.modified | int64 | Optional | |
| createdByEmployee.recentLocation.name | string | Optional | |
| createdByEmployee.recentLocation.shopId | string | Optional | |
| createdByEmployee.recentLocation.terminalId | string | Optional | |
| createdByEmployee.recentLocation.timeCardId | string | Optional | |
| createdByEmployee.recentLocation.updated | boolean | Optional | |
| createdByEmployee.registrationExpireDate | int64 | Optional | |
| createdByEmployee.role | object | Role | Optional |
| createdByEmployee.role.companyId | string | Optional | |
| createdByEmployee.role.created | int64 | Optional | |
| createdByEmployee.role.deleted | boolean | Optional | |
| createdByEmployee.role.id | string | Optional | |
| createdByEmployee.role.modified | int64 | Optional | |
| createdByEmployee.role.name | string | Optional | |
| createdByEmployee.role.permissions[] | array of string |
Possible values are:
|
Optional |
| createdByEmployee.role.updated | boolean | Optional | |
| createdByEmployee.roleId | string | Optional | |
| createdByEmployee.shops[] | array of string | Optional | |
| createdByEmployee.terminalName | string | Optional | |
| createdByEmployee.timeCard | object | TimeCard | Optional |
| createdByEmployee.timeCard.clockInTime | int64 | Optional | |
| createdByEmployee.timeCard.clockOutTime | int64 | Optional | |
| createdByEmployee.timeCard.clockin | boolean | Optional | |
| createdByEmployee.timeCard.companyId | string | Optional | |
| createdByEmployee.timeCard.created | int64 | Optional | |
| createdByEmployee.timeCard.deleted | boolean | Optional | |
| createdByEmployee.timeCard.dirty | boolean | Optional | |
| createdByEmployee.timeCard.employeeId | string | Optional | |
| createdByEmployee.timeCard.id | string | Optional | |
| createdByEmployee.timeCard.modified | int64 | Optional | |
| createdByEmployee.timeCard.sessions[] | array | Optional | |
| createdByEmployee.timeCard.sessions[].companyId | string | Optional | |
| createdByEmployee.timeCard.sessions[].created | int64 | Optional | |
| createdByEmployee.timeCard.sessions[].deleted | boolean | Optional | |
| createdByEmployee.timeCard.sessions[].dirty | boolean | Optional | |
| createdByEmployee.timeCard.sessions[].employeeId | string | Optional | |
| createdByEmployee.timeCard.sessions[].endTime | int64 | Optional | |
| createdByEmployee.timeCard.sessions[].id | string | Optional | |
| createdByEmployee.timeCard.sessions[].modified | int64 | Optional | |
| createdByEmployee.timeCard.sessions[].shopId | string | Optional | |
| createdByEmployee.timeCard.sessions[].startTime | int64 | Optional | |
| createdByEmployee.timeCard.sessions[].terminalId | string | Optional | |
| createdByEmployee.timeCard.sessions[].timeCardId | string | Optional | |
| createdByEmployee.timeCard.sessions[].updated | boolean | Optional | |
| createdByEmployee.timeCard.shopId | string | Optional | |
| createdByEmployee.timeCard.updated | boolean | Optional | |
| createdByEmployee.timecardId | string | Optional | |
| createdByEmployee.tookanInfoList[] | array | Optional | |
| createdByEmployee.tookanInfoList[].shopId | string | Optional | |
| createdByEmployee.tookanInfoList[].status | string |
Possible values are:
|
Optional |
| createdByEmployee.tookanInfoList[].teamId | string | Optional | |
| createdByEmployee.tookanInfoList[].tookanAgentId | string | Optional | |
| createdByEmployee.updated | boolean | Optional | |
| createdByEmployee.vehicleLicensePlate | string | Optional | |
| createdByEmployee.vehicleMake | string | Optional | |
| createdByEmployee.vehicleModel | string | Optional | |
| createdByEmployee.vehiclePin | string | Optional | |
| createdByEmployee.vinNo | string | Optional | |
| createdById | string | Optional | |
| defaultRegionByAddress | boolean | Optional | |
| deferred | boolean | Optional | |
| deferredNote | object | Note | Optional |
| deferredNote.created | int64 | Optional | |
| deferredNote.deleted | boolean | Optional | |
| deferredNote.enableOnFleet | boolean | Optional | |
| deferredNote.id | string | Optional | |
| deferredNote.message | string | Optional | |
| deferredNote.modified | int64 | Optional | |
| deferredNote.updated | boolean | Optional | |
| deferredNote.writerId | string | Optional | |
| deferredNote.writerName | string | Optional | |
| deferredTime | int64 | Optional | |
| dejavooTerminalConfig | object | DejavooTerminalConfig | Optional |
| dejavooTerminalConfig.authKey | string | Optional | |
| dejavooTerminalConfig.created | int64 | Optional | |
| dejavooTerminalConfig.deleted | boolean | Optional | |
| dejavooTerminalConfig.enabled | boolean | Optional | |
| dejavooTerminalConfig.id | string | Optional | |
| dejavooTerminalConfig.manual | boolean | Optional | |
| dejavooTerminalConfig.modified | int64 | Optional | |
| dejavooTerminalConfig.name | string | Optional | |
| dejavooTerminalConfig.online | boolean | Optional | |
| dejavooTerminalConfig.processors[] | array of int32 | Optional | |
| dejavooTerminalConfig.registerId | string | Optional | |
| dejavooTerminalConfig.serialNumber | string | Optional | |
| dejavooTerminalConfig.terminalId | string | Optional | |
| dejavooTerminalConfig.updated | boolean | Optional | |
| deleteNote | object | Note | Optional |
| deleteNote.created | int64 | Optional | |
| deleteNote.deleted | boolean | Optional | |
| deleteNote.enableOnFleet | boolean | Optional | |
| deleteNote.id | string | Optional | |
| deleteNote.message | string | Optional | |
| deleteNote.modified | int64 | Optional | |
| deleteNote.updated | boolean | Optional | |
| deleteNote.writerId | string | Optional | |
| deleteNote.writerName | string | Optional | |
| deleted | boolean | Optional | |
| deliveryAddress | object | Address | Optional |
| deliveryAddress.address | string | Optional | |
| deliveryAddress.addressLine2 | string | Optional | |
| deliveryAddress.city | string | Optional | |
| deliveryAddress.companyId | string | Optional | |
| deliveryAddress.country | string | Optional | |
| deliveryAddress.created | int64 | Optional | |
| deliveryAddress.deleted | boolean | Optional | |
| deliveryAddress.id | string | Optional | |
| deliveryAddress.latitude | number | Optional | |
| deliveryAddress.longitude | number | Optional | |
| deliveryAddress.modified | int64 | Optional | |
| deliveryAddress.state | string | Optional | |
| deliveryAddress.updated | boolean | Optional | |
| deliveryAddress.zipCode | string | Optional | |
| deliveryDate | int64 | Optional | |
| deliveryTraceMessage | string | Optional | |
| dirty | boolean | Optional | |
| dispatchCreatedTime | int64 | Optional | |
| dispatchRegion | object | BlazeRegion | Optional |
| dispatchRegion.active | boolean | Optional | |
| dispatchRegion.closeAt | string | Optional | |
| dispatchRegion.closeAtNumeric | int32 | Optional | |
| dispatchRegion.companyId | string | Optional | |
| dispatchRegion.created | int64 | Optional | |
| dispatchRegion.daysClose[] | array of string | Optional | |
| dispatchRegion.daysOperation[] | array of string | Optional | |
| dispatchRegion.deleted | boolean | Optional | |
| dispatchRegion.deliveryCharge | number | Optional | |
| dispatchRegion.deliveryFee | number | Optional | |
| dispatchRegion.drivers[] | array | Optional | |
| dispatchRegion.drivers[].address | object | Address | Optional |
| dispatchRegion.drivers[].address.address | string | Optional | |
| dispatchRegion.drivers[].address.addressLine2 | string | Optional | |
| dispatchRegion.drivers[].address.city | string | Optional | |
| dispatchRegion.drivers[].address.companyId | string | Optional | |
| dispatchRegion.drivers[].address.country | string | Optional | |
| dispatchRegion.drivers[].address.created | int64 | Optional | |
| dispatchRegion.drivers[].address.deleted | boolean | Optional | |
| dispatchRegion.drivers[].address.id | string | Optional | |
| dispatchRegion.drivers[].address.latitude | number | Optional | |
| dispatchRegion.drivers[].address.longitude | number | Optional | |
| dispatchRegion.drivers[].address.modified | int64 | Optional | |
| dispatchRegion.drivers[].address.state | string | Optional | |
| dispatchRegion.drivers[].address.updated | boolean | Optional | |
| dispatchRegion.drivers[].address.zipCode | string | Optional | |
| dispatchRegion.drivers[].appAccessList[] | array of string |
Possible values are:
|
Optional |
| dispatchRegion.drivers[].assignedInventoryId | string | Optional | |
| dispatchRegion.drivers[].assignedTerminalId | string | Optional | |
| dispatchRegion.drivers[].canApplyCustomDiscount | boolean | Optional | |
| dispatchRegion.drivers[].cashDrawerStatus | string |
Possible values are:
|
Optional |
| dispatchRegion.drivers[].companyId | string | Optional | |
| dispatchRegion.drivers[].created | int64 | Optional | |
| dispatchRegion.drivers[].deleted | boolean | Optional | |
| dispatchRegion.drivers[].disabled | boolean | Optional | |
| dispatchRegion.drivers[].dlExpirationDate | string | Optional | |
| dispatchRegion.drivers[].driver | boolean | Optional | |
| dispatchRegion.drivers[].driversLicense | string | Optional | |
| dispatchRegion.drivers[].email | string | Optional | |
| dispatchRegion.drivers[].employeeOnFleetInfoList[] | array | Optional | |
| dispatchRegion.drivers[].employeeOnFleetInfoList[].onFleetTeamList[] | array of string | Optional | |
| dispatchRegion.drivers[].employeeOnFleetInfoList[].onFleetWorkerId | string | Optional | |
| dispatchRegion.drivers[].employeeOnFleetInfoList[].shopId | string | Optional | |
| dispatchRegion.drivers[].externalId | string | Optional | |
| dispatchRegion.drivers[].firstName | string | Optional | |
| dispatchRegion.drivers[].id | string | Optional | |
| dispatchRegion.drivers[].insuranceCompanyName | string | Optional | |
| dispatchRegion.drivers[].insuranceExpireDate | int64 | Optional | |
| dispatchRegion.drivers[].inventoryName | string | Optional | |
| dispatchRegion.drivers[].lastLoggedInShopId | string | Optional | |
| dispatchRegion.drivers[].lastLoginTime | int64 | Optional | |
| dispatchRegion.drivers[].lastName | string | Optional | |
| dispatchRegion.drivers[].modified | int64 | Optional | |
| dispatchRegion.drivers[].notes[] | array | Optional | |
| dispatchRegion.drivers[].notes[].created | int64 | Optional | |
| dispatchRegion.drivers[].notes[].deleted | boolean | Optional | |
| dispatchRegion.drivers[].notes[].enableOnFleet | boolean | Optional | |
| dispatchRegion.drivers[].notes[].id | string | Optional | |
| dispatchRegion.drivers[].notes[].message | string | Optional | |
| dispatchRegion.drivers[].notes[].modified | int64 | Optional | |
| dispatchRegion.drivers[].notes[].updated | boolean | Optional | |
| dispatchRegion.drivers[].notes[].writerId | string | Optional | |
| dispatchRegion.drivers[].notes[].writerName | string | Optional | |
| dispatchRegion.drivers[].occupationLicenseNumber | string | Optional | |
| dispatchRegion.drivers[].organizationIds[] | array of string | Optional | |
| dispatchRegion.drivers[].password | string | Optional | |
| dispatchRegion.drivers[].phoneNumber | string | Optional | |
| dispatchRegion.drivers[].pin | string | Optional | |
| dispatchRegion.drivers[].policyNumber | string | Optional | |
| dispatchRegion.drivers[].recentLocation | object | TerminalLocation | Optional |
| dispatchRegion.drivers[].recentLocation.companyId | string | Optional | |
| dispatchRegion.drivers[].recentLocation.created | int64 | Optional | |
| dispatchRegion.drivers[].recentLocation.deleted | boolean | Optional | |
| dispatchRegion.drivers[].recentLocation.deviceId | string | Optional | |
| dispatchRegion.drivers[].recentLocation.dirty | boolean | Optional | |
| dispatchRegion.drivers[].recentLocation.employeeId | string | Optional | |
| dispatchRegion.drivers[].recentLocation.id | string | Optional | |
| dispatchRegion.drivers[].recentLocation.loc[] | array of double | Optional | |
| dispatchRegion.drivers[].recentLocation.modified | int64 | Optional | |
| dispatchRegion.drivers[].recentLocation.name | string | Optional | |
| dispatchRegion.drivers[].recentLocation.shopId | string | Optional | |
| dispatchRegion.drivers[].recentLocation.terminalId | string | Optional | |
| dispatchRegion.drivers[].recentLocation.timeCardId | string | Optional | |
| dispatchRegion.drivers[].recentLocation.updated | boolean | Optional | |
| dispatchRegion.drivers[].registrationExpireDate | int64 | Optional | |
| dispatchRegion.drivers[].role | object | Role | Optional |
| dispatchRegion.drivers[].role.companyId | string | Optional | |
| dispatchRegion.drivers[].role.created | int64 | Optional | |
| dispatchRegion.drivers[].role.deleted | boolean | Optional | |
| dispatchRegion.drivers[].role.id | string | Optional | |
| dispatchRegion.drivers[].role.modified | int64 | Optional | |
| dispatchRegion.drivers[].role.name | string | Optional | |
| dispatchRegion.drivers[].role.permissions[] | array of string |
Possible values are:
|
Optional |
| dispatchRegion.drivers[].role.updated | boolean | Optional | |
| dispatchRegion.drivers[].roleId | string | Optional | |
| dispatchRegion.drivers[].shops[] | array of string | Optional | |
| dispatchRegion.drivers[].terminalName | string | Optional | |
| dispatchRegion.drivers[].timeCard | object | TimeCard | Optional |
| dispatchRegion.drivers[].timeCard.clockInTime | int64 | Optional | |
| dispatchRegion.drivers[].timeCard.clockOutTime | int64 | Optional | |
| dispatchRegion.drivers[].timeCard.clockin | boolean | Optional | |
| dispatchRegion.drivers[].timeCard.companyId | string | Optional | |
| dispatchRegion.drivers[].timeCard.created | int64 | Optional | |
| dispatchRegion.drivers[].timeCard.deleted | boolean | Optional | |
| dispatchRegion.drivers[].timeCard.dirty | boolean | Optional | |
| dispatchRegion.drivers[].timeCard.employeeId | string | Optional | |
| dispatchRegion.drivers[].timeCard.id | string | Optional | |
| dispatchRegion.drivers[].timeCard.modified | int64 | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[] | array | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].companyId | string | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].created | int64 | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].deleted | boolean | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].dirty | boolean | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].employeeId | string | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].endTime | int64 | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].id | string | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].modified | int64 | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].shopId | string | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].startTime | int64 | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].terminalId | string | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].timeCardId | string | Optional | |
| dispatchRegion.drivers[].timeCard.sessions[].updated | boolean | Optional | |
| dispatchRegion.drivers[].timeCard.shopId | string | Optional | |
| dispatchRegion.drivers[].timeCard.updated | boolean | Optional | |
| dispatchRegion.drivers[].timecardId | string | Optional | |
| dispatchRegion.drivers[].tookanInfoList[] | array | Optional | |
| dispatchRegion.drivers[].tookanInfoList[].shopId | string | Optional | |
| dispatchRegion.drivers[].tookanInfoList[].status | string |
Possible values are:
|
Optional |
| dispatchRegion.drivers[].tookanInfoList[].teamId | string | Optional | |
| dispatchRegion.drivers[].tookanInfoList[].tookanAgentId | string | Optional | |
| dispatchRegion.drivers[].updated | boolean | Optional | |
| dispatchRegion.drivers[].vehicleLicensePlate | string | Optional | |
| dispatchRegion.drivers[].vehicleMake | string | Optional | |
| dispatchRegion.drivers[].vehicleModel | string | Optional | |
| dispatchRegion.drivers[].vehiclePin | string | Optional | |
| dispatchRegion.drivers[].vinNo | string | Optional | |
| dispatchRegion.fileZone | string | Optional | |
| dispatchRegion.freeDeliveryAfter | number | Optional | |
| dispatchRegion.id | string | Optional | |
| dispatchRegion.inventories[] | array | Optional | |
| dispatchRegion.inventories[].active | boolean | Optional | |
| dispatchRegion.inventories[].companyId | string | Optional | |
| dispatchRegion.inventories[].created | int64 | Optional | |
| dispatchRegion.inventories[].deleted | boolean | Optional | |
| dispatchRegion.inventories[].dirty | boolean | Optional | |
| dispatchRegion.inventories[].dryRoom | boolean | Optional | |
| dispatchRegion.inventories[].externalId | string | Optional | |
| dispatchRegion.inventories[].id | string | Optional | |
| dispatchRegion.inventories[].modified | int64 | Optional | |
| dispatchRegion.inventories[].name | string | Optional | |
| dispatchRegion.inventories[].numTerminals | int32 | Optional | |
| dispatchRegion.inventories[].regionIds[] | array of string | Optional | |
| dispatchRegion.inventories[].shopId | string | Optional | |
| dispatchRegion.inventories[].type | string |
Possible values are:
|
Optional |
| dispatchRegion.inventories[].updated | boolean | Optional | |
| dispatchRegion.kmlColor | string | Optional | |
| dispatchRegion.kmlEdges[] | array | Optional | |
| dispatchRegion.kmlEdges[].active | boolean | Optional | |
| dispatchRegion.kmlEdges[].asset | object | BlazeKmlAsset | Optional |
| dispatchRegion.kmlEdges[].asset.companyId | string | Optional | |
| dispatchRegion.kmlEdges[].asset.created | int64 | Optional | |
| dispatchRegion.kmlEdges[].asset.deleted | boolean | Optional | |
| dispatchRegion.kmlEdges[].asset.id | string | Optional | |
| dispatchRegion.kmlEdges[].asset.key | string | Optional | |
| dispatchRegion.kmlEdges[].asset.modified | int64 | Optional | |
| dispatchRegion.kmlEdges[].asset.name | string | Optional | |
| dispatchRegion.kmlEdges[].asset.secured | boolean | Optional | |
| dispatchRegion.kmlEdges[].asset.type | string | Optional | |
| dispatchRegion.kmlEdges[].asset.updated | boolean | Optional | |
| dispatchRegion.kmlEdges[].coordinates[] | array | Optional | |
| dispatchRegion.kmlEdges[].coordinates[].lat | double | Optional | |
| dispatchRegion.kmlEdges[].coordinates[].lng | double | Optional | |
| dispatchRegion.latitude | double | Optional | |
| dispatchRegion.longitude | double | Optional | |
| dispatchRegion.minOrderAmount | number | Optional | |
| dispatchRegion.modified | int64 | Optional | |
| dispatchRegion.name | string | Optional | |
| dispatchRegion.openAt | string | Optional | |
| dispatchRegion.openAtNumeric | int32 | Optional | |
| dispatchRegion.regionDefault | boolean | Optional | |
| dispatchRegion.shopId | string | Optional | |
| dispatchRegion.shopName | string | Optional | |
| dispatchRegion.taxRuleId | string | Optional | |
| dispatchRegion.terminals[] | array | Optional | |
| dispatchRegion.terminals[].active | boolean | Optional | |
| dispatchRegion.terminals[].appVersion | string | Optional | |
| dispatchRegion.terminals[].assignedInventoryId | string | Optional | |
| dispatchRegion.terminals[].checkoutType | string |
Possible values are:
|
Optional |
| dispatchRegion.terminals[].companyId | string | Optional | |
| dispatchRegion.terminals[].created | int64 | Optional | |
| dispatchRegion.terminals[].creditCardReader | object | CreditCardReader | Optional |
| dispatchRegion.terminals[].creditCardReader.encryptionType | string |
Possible values are:
|
Optional |
| dispatchRegion.terminals[].creditCardReader.secretKey | string | Optional | |
| dispatchRegion.terminals[].currentEmployeeId | string | Optional | |
| dispatchRegion.terminals[].cvAccountId | string | Optional | |
| dispatchRegion.terminals[].deleted | boolean | Optional | |
| dispatchRegion.terminals[].deviceDetails[] | array | Optional | |
| dispatchRegion.terminals[].deviceDetails[].active | boolean | Optional | |
| dispatchRegion.terminals[].deviceDetails[].appType | string |
Possible values are:
|
Optional |
| dispatchRegion.terminals[].deviceDetails[].deviceId | string | Optional | |
| dispatchRegion.terminals[].deviceDetails[].deviceModel | string | Optional | |
| dispatchRegion.terminals[].deviceDetails[].deviceName | string | Optional | |
| dispatchRegion.terminals[].deviceDetails[].deviceToken | string | Optional | |
| dispatchRegion.terminals[].deviceDetails[].deviceType | string |
Possible values are:
|
Optional |
| dispatchRegion.terminals[].deviceDetails[].deviceVersion | string | Optional | |
| dispatchRegion.terminals[].deviceDetails[].sdkVersion | string | Optional | |
| dispatchRegion.terminals[].deviceDetails[].version | string | Optional | |
| dispatchRegion.terminals[].deviceId | string | Optional | |
| dispatchRegion.terminals[].deviceModel | string | Optional | |
| dispatchRegion.terminals[].deviceName | string | Optional | |
| dispatchRegion.terminals[].deviceToken | string | Optional | |
| dispatchRegion.terminals[].deviceType | string | Optional | |
| dispatchRegion.terminals[].deviceVersion | string | Optional | |
| dispatchRegion.terminals[].dirty | boolean | Optional | |
| dispatchRegion.terminals[].id | string | Optional | |
| dispatchRegion.terminals[].modified | int64 | Optional | |
| dispatchRegion.terminals[].name | string | Optional | |
| dispatchRegion.terminals[].onPremEnabled | boolean | Optional | |
| dispatchRegion.terminals[].posTerminal | string | Optional | |
| dispatchRegion.terminals[].regionId | string | Optional | |
| dispatchRegion.terminals[].shopId | string | Optional | |
| dispatchRegion.terminals[].terminalLocations[] | array | Optional | |
| dispatchRegion.terminals[].terminalLocations[].companyId | string | Optional | |
| dispatchRegion.terminals[].terminalLocations[].created | int64 | Optional | |
| dispatchRegion.terminals[].terminalLocations[].deleted | boolean | Optional | |
| dispatchRegion.terminals[].terminalLocations[].deviceId | string | Optional | |
| dispatchRegion.terminals[].terminalLocations[].dirty | boolean | Optional | |
| dispatchRegion.terminals[].terminalLocations[].employeeId | string | Optional | |
| dispatchRegion.terminals[].terminalLocations[].id | string | Optional | |
| dispatchRegion.terminals[].terminalLocations[].loc[] | array of double | Optional | |
| dispatchRegion.terminals[].terminalLocations[].modified | int64 | Optional | |
| dispatchRegion.terminals[].terminalLocations[].name | string | Optional | |
| dispatchRegion.terminals[].terminalLocations[].shopId | string | Optional | |
| dispatchRegion.terminals[].terminalLocations[].terminalId | string | Optional | |
| dispatchRegion.terminals[].terminalLocations[].timeCardId | string | Optional | |
| dispatchRegion.terminals[].terminalLocations[].updated | boolean | Optional | |
| dispatchRegion.terminals[].terminalType | string |
Possible values are:
|
Optional |
| dispatchRegion.terminals[].updated | boolean | Optional | |
| dispatchRegion.updated | boolean | Optional | |
| dispatchRegion.zipCodes[] | array of string | Optional | |
| dispatchRegion.zoneType | string |
Possible values are:
|
Optional |
| dispatchRegionId | string | Optional | |
| dispatchShop | object | Shop | Optional |
| dispatchShop.active | boolean | Optional | |
| dispatchShop.address | object | Address | Optional |
| dispatchShop.address.address | string | Optional | |
| dispatchShop.address.addressLine2 | string | Optional | |
| dispatchShop.address.city | string | Optional | |
| dispatchShop.address.companyId | string | Optional | |
| dispatchShop.address.country | string | Optional | |
| dispatchShop.address.created | int64 | Optional | |
| dispatchShop.address.deleted | boolean | Optional | |
| dispatchShop.address.id | string | Optional | |
| dispatchShop.address.latitude | number | Optional | |
| dispatchShop.address.longitude | number | Optional | |
| dispatchShop.address.modified | int64 | Optional | |
| dispatchShop.address.state | string | Optional | |
| dispatchShop.address.updated | boolean | Optional | |
| dispatchShop.address.zipCode | string | Optional | |
| dispatchShop.ageLimit | int32 | Optional | |
| dispatchShop.alExciseOnZeroPrice | boolean | Optional | |
| dispatchShop.allowAnonymousOrders | boolean | Optional | |
| dispatchShop.appTarget | string |
Possible values are:
|
Optional |
| dispatchShop.appendBrandNameWM | boolean | Optional | |
| dispatchShop.assets[] | array | Optional | |
| dispatchShop.assets[].active | boolean | Optional | |
| dispatchShop.assets[].assetType | string |
Possible values are:
|
Optional |
| dispatchShop.assets[].companyId | string | Optional | |
| dispatchShop.assets[].created | int64 | Optional | |
| dispatchShop.assets[].deleted | boolean | Optional | |
| dispatchShop.assets[].id | string | Optional | |
| dispatchShop.assets[].key | string | Optional | |
| dispatchShop.assets[].largeURL | string | Optional | |
| dispatchShop.assets[].largeX2URL | string | Optional | |
| dispatchShop.assets[].mediumURL | string | Optional | |
| dispatchShop.assets[].modified | int64 | Optional | |
| dispatchShop.assets[].name | string | Optional | |
| dispatchShop.assets[].origURL | string | Optional | |
| dispatchShop.assets[].priority | int32 | Optional | |
| dispatchShop.assets[].publicURL | string | Optional | |
| dispatchShop.assets[].secured | boolean | Optional | |
| dispatchShop.assets[].thumbURL | string | Optional | |
| dispatchShop.assets[].type | string |
Possible values are:
|
Optional |
| dispatchShop.assets[].updated | boolean | Optional | |
| dispatchShop.autoCashDrawer | boolean | Optional | |
| dispatchShop.bccEmailAddress | string | Optional | |
| dispatchShop.blazeConnections[] | array of string | Optional | |
| dispatchShop.blazePayFeeList[] | array | Optional | |
| dispatchShop.blazePayFeeList[].companyId | string | Optional | |
| dispatchShop.blazePayFeeList[].created | int64 | Optional | |
| dispatchShop.blazePayFeeList[].deleted | boolean | Optional | |
| dispatchShop.blazePayFeeList[].dirty | boolean | Optional | |
| dispatchShop.blazePayFeeList[].enabled | boolean | Optional | |
| dispatchShop.blazePayFeeList[].fee | number | Optional | |
| dispatchShop.blazePayFeeList[].feeType | string |
Possible values are:
|
Optional |
| dispatchShop.blazePayFeeList[].id | string | Optional | |
| dispatchShop.blazePayFeeList[].modified | int64 | Optional | |
| dispatchShop.blazePayFeeList[].shopId | string | Optional | |
| dispatchShop.blazePayFeeList[].subTotalThreshold | number | Optional | |
| dispatchShop.blazePayFeeList[].type | string |
Possible values are:
|
Optional |
| dispatchShop.blazePayFeeList[].updated | boolean | Optional | |
| dispatchShop.cartMinimums | object | CartMinimums | Optional |
| dispatchShop.cartMinimums.cartMinimumDetails[] | array | Optional | |
| dispatchShop.cartMinimums.cartMinimumDetails[].distance | number | Optional | |
| dispatchShop.cartMinimums.cartMinimumDetails[].enabled | boolean | Optional | |
| dispatchShop.cartMinimums.cartMinimumDetails[].minimum | number | Optional | |
| dispatchShop.cartMinimums.cartMinimumDetails[].zipCodes[] | array of string | Optional | |
| dispatchShop.cartMinimums.companyId | string | Optional | |
| dispatchShop.cartMinimums.created | int64 | Optional | |
| dispatchShop.cartMinimums.deleted | boolean | Optional | |
| dispatchShop.cartMinimums.id | string | Optional | |
| dispatchShop.cartMinimums.minimumsType | string |
Possible values are:
|
Optional |
| dispatchShop.cartMinimums.modified | int64 | Optional | |
| dispatchShop.cartMinimums.updated | boolean | Optional | |
| dispatchShop.checkDuplicateDl | boolean | Optional | |
| dispatchShop.checkoutType | string |
Possible values are:
|
Optional |
| dispatchShop.companyId | string | Optional | |
| dispatchShop.created | int64 | Optional | |
| dispatchShop.creditCardFeeList[] | array | Optional | |
| dispatchShop.creditCardFeeList[].companyId | string | Optional | |
| dispatchShop.creditCardFeeList[].created | int64 | Optional | |
| dispatchShop.creditCardFeeList[].deleted | boolean | Optional | |
| dispatchShop.creditCardFeeList[].dirty | boolean | Optional | |
| dispatchShop.creditCardFeeList[].enabled | boolean | Optional | |
| dispatchShop.creditCardFeeList[].fee | number | Optional | |
| dispatchShop.creditCardFeeList[].feeType | string |
Possible values are:
|
Optional |
| dispatchShop.creditCardFeeList[].id | string | Optional | |
| dispatchShop.creditCardFeeList[].modified | int64 | Optional | |
| dispatchShop.creditCardFeeList[].shopId | string | Optional | |
| dispatchShop.creditCardFeeList[].subTotalThreshold | number | Optional | |
| dispatchShop.creditCardFeeList[].type | string |
Possible values are:
|
Optional |
| dispatchShop.creditCardFeeList[].updated | boolean | Optional | |
| dispatchShop.creditFefundType | string |
Possible values are:
|
Optional |
| dispatchShop.defaultCountry | string | Optional | |
| dispatchShop.defaultHandOverMin | int32 | Optional | |
| dispatchShop.defaultPinTimeout | int32 | Optional | |
| dispatchShop.deleted | boolean | Optional | |
| dispatchShop.deliveryFee | number | Optional | |
| dispatchShop.deliveryFees[] | array | Optional | |
| dispatchShop.deliveryFees[].companyId | string | Optional | |
| dispatchShop.deliveryFees[].created | int64 | Optional | |
| dispatchShop.deliveryFees[].deleted | boolean | Optional | |
| dispatchShop.deliveryFees[].distance | number | Optional | |
| dispatchShop.deliveryFees[].enabled | boolean | Optional | |
| dispatchShop.deliveryFees[].fee | number | Optional | |
| dispatchShop.deliveryFees[].feeType | string |
Possible values are:
|
Optional |
| dispatchShop.deliveryFees[].id | string | Optional | |
| dispatchShop.deliveryFees[].modified | int64 | Optional | |
| dispatchShop.deliveryFees[].subTotalThreshold | number | Optional | |
| dispatchShop.deliveryFees[].type | string |
Possible values are:
|
Optional |
| dispatchShop.deliveryFees[].updated | boolean | Optional | |
| dispatchShop.deliveryFees[].zipCodes[] | array of string | Optional | |
| dispatchShop.deliveryMaxOrders | int32 | Optional | |
| dispatchShop.deliveryRefundType | string |
Possible values are:
|
Optional |
| dispatchShop.disableMedicalProductsForAdultUse | boolean | Optional | |
| dispatchShop.emailAdress | string | Optional | |
| dispatchShop.emailAttachment | object | CompanyAsset | Optional |
| dispatchShop.emailAttachment.active | boolean | Optional | |
| dispatchShop.emailAttachment.assetType | string |
Possible values are:
|
Optional |
| dispatchShop.emailAttachment.companyId | string | Optional | |
| dispatchShop.emailAttachment.created | int64 | Optional | |
| dispatchShop.emailAttachment.deleted | boolean | Optional | |
| dispatchShop.emailAttachment.id | string | Optional | |
| dispatchShop.emailAttachment.key | string | Optional | |
| dispatchShop.emailAttachment.largeURL | string | Optional | |
| dispatchShop.emailAttachment.largeX2URL | string | Optional | |
| dispatchShop.emailAttachment.mediumURL | string | Optional | |
| dispatchShop.emailAttachment.modified | int64 | Optional | |
| dispatchShop.emailAttachment.name | string | Optional | |
| dispatchShop.emailAttachment.origURL | string | Optional | |
| dispatchShop.emailAttachment.priority | int32 | Optional | |
| dispatchShop.emailAttachment.publicURL | string | Optional | |
| dispatchShop.emailAttachment.secured | boolean | Optional | |
| dispatchShop.emailAttachment.thumbURL | string | Optional | |
| dispatchShop.emailAttachment.type | string |
Possible values are:
|
Optional |
| dispatchShop.emailAttachment.updated | boolean | Optional | |
| dispatchShop.emailList[] | array of string | Optional | |
| dispatchShop.emailMessage | string | Optional | |
| dispatchShop.enableAfterTaxDiscountNotes | boolean | Optional | |
| dispatchShop.enableAgeLimit | boolean | Optional | |
| dispatchShop.enableAutoPrintAtFulfillment | boolean | Optional | |
| dispatchShop.enableBCCReceipt | boolean | Optional | |
| dispatchShop.enableCannabisLimit | boolean | Optional | |
| dispatchShop.enableCartDiscountNotes | boolean | Optional | |
| dispatchShop.enableCashInOut | boolean | Optional | |
| dispatchShop.enableCommittedValidation | boolean | Optional | |
| dispatchShop.enableComplianceTesting | boolean | Optional | |
| dispatchShop.enableCustomerIdentification | boolean | Optional | |
| dispatchShop.enableDOBNameUniqueness | boolean | Optional | |
| dispatchShop.enableDailySummaryEmail | boolean | Optional | |
| dispatchShop.enableDeferTransactions | boolean | Optional | |
| dispatchShop.enableDeliveryFee | boolean | Optional | |
| dispatchShop.enableDeliverySignature | boolean | Optional | |
| dispatchShop.enableDiscountNotes | boolean | Optional | |
| dispatchShop.enableExciseTax | boolean | Optional | |
| dispatchShop.enableGPSTracking | boolean | Optional | |
| dispatchShop.enableHarvestTax | boolean | Optional | |
| dispatchShop.enableIncomingOrders | boolean | Optional | |
| dispatchShop.enableLowInventoryEmail | boolean | Optional | |
| dispatchShop.enableMedicinalAge | boolean | Optional | |
| dispatchShop.enableOnFleet | boolean | Optional | |
| dispatchShop.enablePinForCashDrawer | boolean | Optional | |
| dispatchShop.enableRefundNote | boolean | Optional | |
| dispatchShop.enableSaleLogout | boolean | Optional | |
| dispatchShop.enableSpringBig | boolean | Optional | |
| dispatchShop.enableTip | boolean | Optional | |
| dispatchShop.enableTipsBlazePay | boolean | Optional | |
| dispatchShop.enableTookan | boolean | Optional | |
| dispatchShop.enableUnAssignedOnfleetOrder | boolean | Optional | |
| dispatchShop.enableWaive | boolean | Optional | |
| dispatchShop.enableWooCommerce | boolean | Optional | |
| dispatchShop.enforceCashDrawers | boolean | Optional | |
| dispatchShop.exciseTaxType | string |
Possible values are:
|
Optional |
| dispatchShop.flowerType[] | array of string | Optional | |
| dispatchShop.getdraftOrderTimeout | int32 | Optional | |
| dispatchShop.hubId | string | Optional | |
| dispatchShop.hubName | string | Optional | |
| dispatchShop.id | string | Optional | |
| dispatchShop.invoiceNote | string | Optional | |
| dispatchShop.invoiceTermCondition | string | Optional | |
| dispatchShop.latitude | double | Optional | |
| dispatchShop.legalLanguage | string | Optional | |
| dispatchShop.license | string | Optional | |
| dispatchShop.logo | object | CompanyAsset | Optional |
| dispatchShop.logo.active | boolean | Optional | |
| dispatchShop.logo.assetType | string |
Possible values are:
|
Optional |
| dispatchShop.logo.companyId | string | Optional | |
| dispatchShop.logo.created | int64 | Optional | |
| dispatchShop.logo.deleted | boolean | Optional | |
| dispatchShop.logo.id | string | Optional | |
| dispatchShop.logo.key | string | Optional | |
| dispatchShop.logo.largeURL | string | Optional | |
| dispatchShop.logo.largeX2URL | string | Optional | |
| dispatchShop.logo.mediumURL | string | Optional | |
| dispatchShop.logo.modified | int64 | Optional | |
| dispatchShop.logo.name | string | Optional | |
| dispatchShop.logo.origURL | string | Optional | |
| dispatchShop.logo.priority | int32 | Optional | |
| dispatchShop.logo.publicURL | string | Optional | |
| dispatchShop.logo.secured | boolean | Optional | |
| dispatchShop.logo.thumbURL | string | Optional | |
| dispatchShop.logo.type | string |
Possible values are:
|
Optional |
| dispatchShop.logo.updated | boolean | Optional | |
| dispatchShop.longitude | double | Optional | |
| dispatchShop.marketingSources[] | array of string | Optional | |
| dispatchShop.medicinalAge | int32 | Optional | |
| dispatchShop.membersCountSyncDate | int64 | Optional | |
| dispatchShop.membersTag[] | array of string | Optional | |
| dispatchShop.modified | int64 | Optional | |
| dispatchShop.nalExciseFromRetailCost | boolean | Optional | |
| dispatchShop.name | string | Optional | |
| dispatchShop.nextSnapshotTime | int64 | Optional | |
| dispatchShop.nonCannabisTaxes | object | NonCannabisTaxInfo | Optional |
| dispatchShop.nonCannabisTaxes.alExciseOnZeroPrice | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.enableNonCannabisTax | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.nalExciseFromRetailCost | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.nonCannabisType | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxInfo | object | TaxInfo | Optional |
| dispatchShop.nonCannabisTaxes.taxInfo.cityTax | number | Optional | |
| dispatchShop.nonCannabisTaxes.taxInfo.created | int64 | Optional | |
| dispatchShop.nonCannabisTaxes.taxInfo.deleted | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxInfo.federalTax | number | Optional | |
| dispatchShop.nonCannabisTaxes.taxInfo.id | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxInfo.modified | int64 | Optional | |
| dispatchShop.nonCannabisTaxes.taxInfo.stateTax | number | Optional | |
| dispatchShop.nonCannabisTaxes.taxInfo.updated | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxOrder | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxTables[] | array | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].active | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax | object | CompoundTaxRate | Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.active | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.activeExciseTax | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.companyId | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.compound | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.created | int64 | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.deleted | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.dirty | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.displayName | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.id | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.modified | int64 | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.shopId | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.taxOrder | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.taxRate | number | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.territory | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].cityTax.updated | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].companyId | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].consumerType | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax | object | CompoundTaxRate | Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.active | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.activeExciseTax | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.companyId | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.compound | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.created | int64 | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.deleted | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.dirty | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.displayName | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.id | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.modified | int64 | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.shopId | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.taxOrder | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.taxRate | number | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.territory | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].countyTax.updated | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].created | int64 | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].deleted | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].dirty | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax | object | CompoundTaxRate | Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.active | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.activeExciseTax | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.companyId | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.compound | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.created | int64 | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.deleted | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.dirty | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.displayName | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.id | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.modified | int64 | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.shopId | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.taxOrder | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.taxRate | number | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.territory | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].federalTax.updated | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].id | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].modified | int64 | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].name | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].shopId | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax | object | CompoundTaxRate | Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.active | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.activeExciseTax | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.companyId | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.compound | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.created | int64 | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.deleted | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.dirty | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.displayName | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.id | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.modified | int64 | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.shopId | string | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.taxOrder | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.taxRate | number | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.territory | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].stateTax.updated | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.taxTables[].taxOrder | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].taxType | string |
Possible values are:
|
Optional |
| dispatchShop.nonCannabisTaxes.taxTables[].updated | boolean | Optional | |
| dispatchShop.nonCannabisTaxes.useComplexTax | boolean | Optional | |
| dispatchShop.numAllowActiveTrans | int32 | Optional | |
| dispatchShop.onFleetAllowEmptyOrders | boolean | Optional | |
| dispatchShop.onFleetApiKey | string | Optional | |
| dispatchShop.onFleetOrganizationId | string | Optional | |
| dispatchShop.onFleetOrganizationName | string | Optional | |
| dispatchShop.onFleetRequired | boolean | Optional | |
| dispatchShop.onFleetTwoAutoPack | boolean | Optional | |
| dispatchShop.onFleetTwoWay | boolean | Optional | |
| dispatchShop.onFleetTwoWayRevert | boolean | Optional | |
| dispatchShop.onFleetTwoWayUpdateSchedule | boolean | Optional | |
| dispatchShop.onfleetOverrideUrl | string | Optional | |
| dispatchShop.onlineStoreInfo | object | OnlineStoreInfo | Optional |
| dispatchShop.onlineStoreInfo.activeInventoryId | string | Optional | |
| dispatchShop.onlineStoreInfo.cartMinType | string |
Possible values are:
|
Optional |
| dispatchShop.onlineStoreInfo.cartMinimum | number | Optional | |
| dispatchShop.onlineStoreInfo.colorTheme | string |
Possible values are:
|
Optional |
| dispatchShop.onlineStoreInfo.companyId | string | Optional | |
| dispatchShop.onlineStoreInfo.created | int64 | Optional | |
| dispatchShop.onlineStoreInfo.customCss | string | Optional | |
| dispatchShop.onlineStoreInfo.customMessageETA | string | Optional | |
| dispatchShop.onlineStoreInfo.defaultETA | int32 | Optional | |
| dispatchShop.onlineStoreInfo.deleted | boolean | Optional | |
| dispatchShop.onlineStoreInfo.dirty | boolean | Optional | |
| dispatchShop.onlineStoreInfo.enableDelivery | boolean | Optional | |
| dispatchShop.onlineStoreInfo.enableDeliveryAreaRestrictions | boolean | Optional | |
| dispatchShop.onlineStoreInfo.enableHtmlText | boolean | Optional | |
| dispatchShop.onlineStoreInfo.enableInventory | boolean | Optional | |
| dispatchShop.onlineStoreInfo.enableInventoryType | string |
Possible values are:
|
Optional |
| dispatchShop.onlineStoreInfo.enableOnlinePOS | boolean | Optional | |
| dispatchShop.onlineStoreInfo.enableOnlineShipment | boolean | Optional | |
| dispatchShop.onlineStoreInfo.enableOtherMarketingSource | boolean | Optional | |
| dispatchShop.onlineStoreInfo.enableProductReviews | boolean | Optional | |
| dispatchShop.onlineStoreInfo.enableStorePickup | boolean | Optional | |
| dispatchShop.onlineStoreInfo.enabled | boolean | Optional | |
| dispatchShop.onlineStoreInfo.htmlText | string | Optional | |
| dispatchShop.onlineStoreInfo.id | string | Optional | |
| dispatchShop.onlineStoreInfo.modified | int64 | Optional | |
| dispatchShop.onlineStoreInfo.pageOneMessageBody | string | Optional | |
| dispatchShop.onlineStoreInfo.pageOneMessageTitle | string | Optional | |
| dispatchShop.onlineStoreInfo.restrictedZipCodes[] | array of string | Optional | |
| dispatchShop.onlineStoreInfo.shopId | string | Optional | |
| dispatchShop.onlineStoreInfo.storeHexColor | string | Optional | |
| dispatchShop.onlineStoreInfo.submissionMessage | string | Optional | |
| dispatchShop.onlineStoreInfo.supportEmail | string | Optional | |
| dispatchShop.onlineStoreInfo.updated | boolean | Optional | |
| dispatchShop.onlineStoreInfo.useCustomETA | boolean | Optional | |
| dispatchShop.onlineStoreInfo.viewType | string |
Possible values are:
|
Optional |
| dispatchShop.onlineStoreInfo.websiteOrigins | string | Optional | |
| dispatchShop.onlineStoreInfo.websiteUrl | string | Optional | |
| dispatchShop.orderTags[] | array of string | Optional | |
| dispatchShop.pennyTransactionOption | string |
Possible values are:
|
Optional |
| dispatchShop.phoneNumber | string | Optional | |
| dispatchShop.poNote | string | Optional | |
| dispatchShop.poTermCondition | string | Optional | |
| dispatchShop.productPriceIncludeExciseTax | boolean | Optional | |
| dispatchShop.productsTag[] | array of string | Optional | |
| dispatchShop.receiptInfo[] | array | Optional | |
| dispatchShop.receiptInfo[].aboveFreeText | string | Optional | |
| dispatchShop.receiptInfo[].companyId | string | Optional | |
| dispatchShop.receiptInfo[].created | int64 | Optional | |
| dispatchShop.receiptInfo[].deleted | boolean | Optional | |
| dispatchShop.receiptInfo[].dirty | boolean | Optional | |
| dispatchShop.receiptInfo[].emailAttachment | object | CompanyAsset | Optional |
| dispatchShop.receiptInfo[].emailAttachment.active | boolean | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.assetType | string |
Possible values are:
|
Optional |
| dispatchShop.receiptInfo[].emailAttachment.companyId | string | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.created | int64 | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.deleted | boolean | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.id | string | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.key | string | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.largeURL | string | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.largeX2URL | string | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.mediumURL | string | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.modified | int64 | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.name | string | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.origURL | string | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.priority | int32 | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.publicURL | string | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.secured | boolean | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.thumbURL | string | Optional | |
| dispatchShop.receiptInfo[].emailAttachment.type | string |
Possible values are:
|
Optional |
| dispatchShop.receiptInfo[].emailAttachment.updated | boolean | Optional | |
| dispatchShop.receiptInfo[].emailMessage | string | Optional | |
| dispatchShop.receiptInfo[].enableBrand | boolean | Optional | |
| dispatchShop.receiptInfo[].enableEmployeeId | boolean | Optional | |
| dispatchShop.receiptInfo[].enableEmployeeName | boolean | Optional | |
| dispatchShop.receiptInfo[].enableExciseTaxAsItem | boolean | Optional | |
| dispatchShop.receiptInfo[].enableIncludeItemInSKU | boolean | Optional | |
| dispatchShop.receiptInfo[].enableItemDiscount | boolean | Optional | |
| dispatchShop.receiptInfo[].enableItemDiscountNotes | boolean | Optional | |
| dispatchShop.receiptInfo[].enableLicenseeBusinessName | boolean | Optional | |
| dispatchShop.receiptInfo[].enableMemberAddress | boolean | Optional | |
| dispatchShop.receiptInfo[].enableMemberId | boolean | Optional | |
| dispatchShop.receiptInfo[].enableMemberLoyaltyPoints | boolean | Optional | |
| dispatchShop.receiptInfo[].enableMemberName | boolean | Optional | |
| dispatchShop.receiptInfo[].enableMemberPhoneNo | boolean | Optional | |
| dispatchShop.receiptInfo[].enableNotes | boolean | Optional | |
| dispatchShop.receiptInfo[].enableOrderDateTime | boolean | Optional | |
| dispatchShop.receiptInfo[].enablePreparedByEmployeeId | boolean | Optional | |
| dispatchShop.receiptInfo[].enableShopAddress | boolean | Optional | |
| dispatchShop.receiptInfo[].enableShopLicenseNumber | boolean | Optional | |
| dispatchShop.receiptInfo[].enableShopPhoneNo | boolean | Optional | |
| dispatchShop.receiptInfo[].enabledBottomFreeText | boolean | Optional | |
| dispatchShop.receiptInfo[].enabledFreeText | boolean | Optional | |
| dispatchShop.receiptInfo[].freeText | string | Optional | |
| dispatchShop.receiptInfo[].id | string | Optional | |
| dispatchShop.receiptInfo[].licenseeBusinessName | string | Optional | |
| dispatchShop.receiptInfo[].modified | int64 | Optional | |
| dispatchShop.receiptInfo[].receiptType | string |
Possible values are:
|
Optional |
| dispatchShop.receiptInfo[].shopId | string | Optional | |
| dispatchShop.receiptInfo[].updated | boolean | Optional | |
| dispatchShop.receivingInventoryId | string | Optional | |
| dispatchShop.requireValidRecDate | boolean | Optional | |
| dispatchShop.restrictIncomingOrderNotifications | boolean | Optional | |
| dispatchShop.restrictedNotificationTerminals[] | array of string | Optional | |
| dispatchShop.restrictedViews | boolean | Optional | |
| dispatchShop.roundOffType | string |
Possible values are:
|
Optional |
| dispatchShop.roundUpMessage | string | Optional | |
| dispatchShop.shopType | string |
Possible values are:
|
Optional |
| dispatchShop.shortIdentifier | string | Optional | |
| dispatchShop.showDeliveryQueue | boolean | Optional | |
| dispatchShop.showOnlineQueue | boolean | Optional | |
| dispatchShop.showProductByAvailableQuantity | boolean | Optional | |
| dispatchShop.showSpecialQueue | boolean | Optional | |
| dispatchShop.showWalkInQueue | boolean | Optional | |
| dispatchShop.snapshopTime | int64 | Optional | |
| dispatchShop.taxInfo | object | TaxInfo | Optional |
| dispatchShop.taxInfo.cityTax | number | Optional | |
| dispatchShop.taxInfo.created | int64 | Optional | |
| dispatchShop.taxInfo.deleted | boolean | Optional | |
| dispatchShop.taxInfo.federalTax | number | Optional | |
| dispatchShop.taxInfo.id | string | Optional | |
| dispatchShop.taxInfo.modified | int64 | Optional | |
| dispatchShop.taxInfo.stateTax | number | Optional | |
| dispatchShop.taxInfo.updated | boolean | Optional | |
| dispatchShop.taxOrder | string |
Possible values are:
|
Optional |
| dispatchShop.taxRoundOffType | string |
Possible values are:
|
Optional |
| dispatchShop.taxTables[] | array | Optional | |
| dispatchShop.taxTables[].active | boolean | Optional | |
| dispatchShop.taxTables[].cityTax | object | CompoundTaxRate | Optional |
| dispatchShop.taxTables[].cityTax.active | boolean | Optional | |
| dispatchShop.taxTables[].cityTax.activeExciseTax | boolean | Optional | |
| dispatchShop.taxTables[].cityTax.companyId | string | Optional | |
| dispatchShop.taxTables[].cityTax.compound | boolean | Optional | |
| dispatchShop.taxTables[].cityTax.created | int64 | Optional | |
| dispatchShop.taxTables[].cityTax.deleted | boolean | Optional | |
| dispatchShop.taxTables[].cityTax.dirty | boolean | Optional | |
| dispatchShop.taxTables[].cityTax.displayName | string | Optional | |
| dispatchShop.taxTables[].cityTax.id | string | Optional | |
| dispatchShop.taxTables[].cityTax.modified | int64 | Optional | |
| dispatchShop.taxTables[].cityTax.shopId | string | Optional | |
| dispatchShop.taxTables[].cityTax.taxOrder | string |
Possible values are:
|
Optional |
| dispatchShop.taxTables[].cityTax.taxRate | number | Optional | |
| dispatchShop.taxTables[].cityTax.territory | string |
Possible values are:
|
Optional |
| dispatchShop.taxTables[].cityTax.updated | boolean | Optional | |
| dispatchShop.taxTables[].companyId | string | Optional | |
| dispatchShop.taxTables[].consumerType | string |
Possible values are:
|
Optional |
| dispatchShop.taxTables[].countyTax | object | CompoundTaxRate | Optional |
| dispatchShop.taxTables[].countyTax.active | boolean | Optional | |
| dispatchShop.taxTables[].countyTax.activeExciseTax | boolean | Optional | |
| dispatchShop.taxTables[].countyTax.companyId | string | Optional | |
| dispatchShop.taxTables[].countyTax.compound | boolean | Optional | |
| dispatchShop.taxTables[].countyTax.created | int64 | Optional | |
| dispatchShop.taxTables[].countyTax.deleted | boolean | Optional | |
| dispatchShop.taxTables[].countyTax.dirty | boolean | Optional | |
| dispatchShop.taxTables[].countyTax.displayName | string | Optional | |
| dispatchShop.taxTables[].countyTax.id | string | Optional | |
| dispatchShop.taxTables[].countyTax.modified | int64 | Optional | |
| dispatchShop.taxTables[].countyTax.shopId | string | Optional | |
| dispatchShop.taxTables[].countyTax.taxOrder | string |
Possible values are:
|
Optional |
| dispatchShop.taxTables[].countyTax.taxRate | number | Optional | |
| dispatchShop.taxTables[].countyTax.territory | string |
Possible values are:
|
Optional |
| dispatchShop.taxTables[].countyTax.updated | boolean | Optional | |
| dispatchShop.taxTables[].created | int64 | Optional | |
| dispatchShop.taxTables[].deleted | boolean | Optional | |
| dispatchShop.taxTables[].dirty | boolean | Optional | |
| dispatchShop.taxTables[].federalTax | object | CompoundTaxRate | Optional |
| dispatchShop.taxTables[].federalTax.active | boolean | Optional | |
| dispatchShop.taxTables[].federalTax.activeExciseTax | boolean | Optional | |
| dispatchShop.taxTables[].federalTax.companyId | string | Optional | |
| dispatchShop.taxTables[].federalTax.compound | boolean | Optional | |
| dispatchShop.taxTables[].federalTax.created | int64 | Optional | |
| dispatchShop.taxTables[].federalTax.deleted | boolean | Optional | |
| dispatchShop.taxTables[].federalTax.dirty | boolean | Optional | |
| dispatchShop.taxTables[].federalTax.displayName | string | Optional | |
| dispatchShop.taxTables[].federalTax.id | string | Optional | |
| dispatchShop.taxTables[].federalTax.modified | int64 | Optional | |
| dispatchShop.taxTables[].federalTax.shopId | string | Optional | |
| dispatchShop.taxTables[].federalTax.taxOrder | string |
Possible values are:
|
Optional |
| dispatchShop.taxTables[].federalTax.taxRate | number | Optional | |
| dispatchShop.taxTables[].federalTax.territory | string |
Possible values are:
|
Optional |
| dispatchShop.taxTables[].federalTax.updated | boolean | Optional | |
| dispatchShop.taxTables[].id | string | Optional | |
| dispatchShop.taxTables[].modified | int64 | Optional | |
| dispatchShop.taxTables[].name | string | Optional | |
| dispatchShop.taxTables[].shopId | string | Optional | |
| dispatchShop.taxTables[].stateTax | object | CompoundTaxRate | Optional |
| dispatchShop.taxTables[].stateTax.active | boolean | Optional | |
| dispatchShop.taxTables[].stateTax.activeExciseTax | boolean | Optional | |
| dispatchShop.taxTables[].stateTax.companyId | string | Optional | |
| dispatchShop.taxTables[].stateTax.compound | boolean | Optional | |
| dispatchShop.taxTables[].stateTax.created | int64 | Optional | |
| dispatchShop.taxTables[].stateTax.deleted | boolean | Optional | |
| dispatchShop.taxTables[].stateTax.dirty | boolean | Optional | |
| dispatchShop.taxTables[].stateTax.displayName | string | Optional | |
| dispatchShop.taxTables[].stateTax.id | string | Optional | |
| dispatchShop.taxTables[].stateTax.modified | int64 | Optional | |
| dispatchShop.taxTables[].stateTax.shopId | string | Optional | |
| dispatchShop.taxTables[].stateTax.taxOrder | string |
Possible values are:
|
Optional |
| dispatchShop.taxTables[].stateTax.taxRate | number | Optional | |
| dispatchShop.taxTables[].stateTax.territory | string |
Possible values are:
|
Optional |
| dispatchShop.taxTables[].stateTax.updated | boolean | Optional | |
| dispatchShop.taxTables[].taxOrder | string |
Possible values are:
|
Optional |
| dispatchShop.taxTables[].taxType | string |
Possible values are:
|
Optional |
| dispatchShop.taxTables[].updated | boolean | Optional | |
| dispatchShop.termSalesOption | string |
Possible values are:
|
Optional |
| dispatchShop.timeZone | string | Optional | |
| dispatchShop.timezoneOffsetInMinutes | int32 | Optional | |
| dispatchShop.tookanRequired | boolean | Optional | |
| dispatchShop.twilioNumber | string | Optional | |
| dispatchShop.updated | boolean | Optional | |
| dispatchShop.useAssignedEmployee | boolean | Optional | |
| dispatchShop.useComplexTax | boolean | Optional | |
| draftCreatedTime | int64 | Optional | |
| enableBlazePayTips | boolean | Optional | |
| endRouteDate | int64 | Optional | |
| endRouteLocation[] | array of double | Optional | |
| endTime | int64 | Optional | |
| entityISN | string | Optional | |
| estimatedLoyaltyPoints | boolean | Optional | |
| eta | int32 | Optional | |
| fulfillingFulfillment | boolean | Optional | |
| fulfillmentStep | string |
Possible values are:
|
Optional |
| hypurCheckinISN | string | Optional | |
| hypurPin | string | Optional | |
| id | string | Optional | |
| identifications[] | array | Optional | |
| identifications[].assets[] | array | Optional | |
| identifications[].assets[].active | boolean | Optional | |
| identifications[].assets[].assetType | string |
Possible values are:
|
Optional |
| identifications[].assets[].companyId | string | Optional | |
| identifications[].assets[].created | int64 | Optional | |
| identifications[].assets[].deleted | boolean | Optional | |
| identifications[].assets[].id | string | Optional | |
| identifications[].assets[].key | string | Optional | |
| identifications[].assets[].largeURL | string | Optional | |
| identifications[].assets[].largeX2URL | string | Optional | |
| identifications[].assets[].mediumURL | string | Optional | |
| identifications[].assets[].modified | int64 | Optional | |
| identifications[].assets[].name | string | Optional | |
| identifications[].assets[].origURL | string | Optional | |
| identifications[].assets[].priority | int32 | Optional | |
| identifications[].assets[].publicURL | string | Optional | |
| identifications[].assets[].secured | boolean | Optional | |
| identifications[].assets[].thumbURL | string | Optional | |
| identifications[].assets[].type | string |
Possible values are:
|
Optional |
| identifications[].assets[].updated | boolean | Optional | |
| identifications[].companyId | string | Optional | |
| identifications[].created | int64 | Optional | |
| identifications[].deleted | boolean | Optional | |
| identifications[].expirationDate | int64 | Optional | |
| identifications[].frontPhoto | object | CompanyAsset | Optional |
| identifications[].frontPhoto.active | boolean | Optional | |
| identifications[].frontPhoto.assetType | string |
Possible values are:
|
Optional |
| identifications[].frontPhoto.companyId | string | Optional | |
| identifications[].frontPhoto.created | int64 | Optional | |
| identifications[].frontPhoto.deleted | boolean | Optional | |
| identifications[].frontPhoto.id | string | Optional | |
| identifications[].frontPhoto.key | string | Optional | |
| identifications[].frontPhoto.largeURL | string | Optional | |
| identifications[].frontPhoto.largeX2URL | string | Optional | |
| identifications[].frontPhoto.mediumURL | string | Optional | |
| identifications[].frontPhoto.modified | int64 | Optional | |
| identifications[].frontPhoto.name | string | Optional | |
| identifications[].frontPhoto.origURL | string | Optional | |
| identifications[].frontPhoto.priority | int32 | Optional | |
| identifications[].frontPhoto.publicURL | string | Optional | |
| identifications[].frontPhoto.secured | boolean | Optional | |
| identifications[].frontPhoto.thumbURL | string | Optional | |
| identifications[].frontPhoto.type | string |
Possible values are:
|
Optional |
| identifications[].frontPhoto.updated | boolean | Optional | |
| identifications[].id | string | Optional | |
| identifications[].licenseNumber | string | Optional | |
| identifications[].modified | int64 | Optional | |
| identifications[].state | string | Optional | |
| identifications[].type | string |
Possible values are:
|
Optional |
| identifications[].updated | boolean | Optional | |
| identifications[].verified | boolean | Optional | |
| inventory | object | Inventory | Optional |
| inventory.active | boolean | Optional | |
| inventory.companyId | string | Optional | |
| inventory.created | int64 | Optional | |
| inventory.deleted | boolean | Optional | |
| inventory.dirty | boolean | Optional | |
| inventory.dryRoom | boolean | Optional | |
| inventory.externalId | string | Optional | |
| inventory.id | string | Optional | |
| inventory.modified | int64 | Optional | |
| inventory.name | string | Optional | |
| inventory.numTerminals | int32 | Optional | |
| inventory.regionIds[] | array of string | Optional | |
| inventory.shopId | string | Optional | |
| inventory.type | string |
Possible values are:
|
Optional |
| inventory.updated | boolean | Optional | |
| inventoryId | string | Optional | |
| loc[] | array of double | Optional | |
| locked | boolean | Optional | |
| member | object | Member | Optional |
| member.address | object | Address | Optional |
| member.address.address | string | Optional | |
| member.address.addressLine2 | string | Optional | |
| member.address.city | string | Optional | |
| member.address.companyId | string | Optional | |
| member.address.country | string | Optional | |
| member.address.created | int64 | Optional | |
| member.address.deleted | boolean | Optional | |
| member.address.id | string | Optional | |
| member.address.latitude | number | Optional | |
| member.address.longitude | number | Optional | |
| member.address.modified | int64 | Optional | |
| member.address.state | string | Optional | |
| member.address.updated | boolean | Optional | |
| member.address.zipCode | string | Optional | |
| member.addresses[] | array | Optional | |
| member.addresses[].address | string | Optional | |
| member.addresses[].addressLine2 | string | Optional | |
| member.addresses[].city | string | Optional | |
| member.addresses[].companyId | string | Optional | |
| member.addresses[].country | string | Optional | |
| member.addresses[].created | int64 | Optional | |
| member.addresses[].deleted | boolean | Optional | |
| member.addresses[].id | string | Optional | |
| member.addresses[].latitude | number | Optional | |
| member.addresses[].longitude | number | Optional | |
| member.addresses[].modified | int64 | Optional | |
| member.addresses[].state | string | Optional | |
| member.addresses[].updated | boolean | Optional | |
| member.addresses[].zipCode | string | Optional | |
| member.agreementExpired | boolean | Optional | |
| member.anonymous | boolean | Optional | |
| member.banPatient | boolean | Optional | |
| member.careGivers[] | array of string | Optional | |
| member.companyId | string | Optional | |
| member.consumerType | string |
Possible values are:
|
Optional |
| member.consumerUserId | string | Optional | |
| member.contracts[] | array | Optional | |
| member.contracts[].companyId | string | Optional | |
| member.contracts[].consumerId | string | Optional | |
| member.contracts[].contractId | string | Optional | |
| member.contracts[].created | int64 | Optional | |
| member.contracts[].deleted | boolean | Optional | |
| member.contracts[].dirty | boolean | Optional | |
| member.contracts[].employeeName | string | Optional | |
| member.contracts[].employeeSignaturePhoto | object | CompanyAsset | Optional |
| member.contracts[].employeeSignaturePhoto.active | boolean | Optional | |
| member.contracts[].employeeSignaturePhoto.assetType | string |
Possible values are:
|
Optional |
| member.contracts[].employeeSignaturePhoto.companyId | string | Optional | |
| member.contracts[].employeeSignaturePhoto.created | int64 | Optional | |
| member.contracts[].employeeSignaturePhoto.deleted | boolean | Optional | |
| member.contracts[].employeeSignaturePhoto.id | string | Optional | |
| member.contracts[].employeeSignaturePhoto.key | string | Optional | |
| member.contracts[].employeeSignaturePhoto.largeURL | string | Optional | |
| member.contracts[].employeeSignaturePhoto.largeX2URL | string | Optional | |
| member.contracts[].employeeSignaturePhoto.mediumURL | string | Optional | |
| member.contracts[].employeeSignaturePhoto.modified | int64 | Optional | |
| member.contracts[].employeeSignaturePhoto.name | string | Optional | |
| member.contracts[].employeeSignaturePhoto.origURL | string | Optional | |
| member.contracts[].employeeSignaturePhoto.priority | int32 | Optional | |
| member.contracts[].employeeSignaturePhoto.publicURL | string | Optional | |
| member.contracts[].employeeSignaturePhoto.secured | boolean | Optional | |
| member.contracts[].employeeSignaturePhoto.thumbURL | string | Optional | |
| member.contracts[].employeeSignaturePhoto.type | string |
Possible values are:
|
Optional |
| member.contracts[].employeeSignaturePhoto.updated | boolean | Optional | |
| member.contracts[].id | string | Optional | |
| member.contracts[].memberName | string | Optional | |
| member.contracts[].membershipId | string | Optional | |
| member.contracts[].modified | int64 | Optional | |
| member.contracts[].shopId | string | Optional | |
| member.contracts[].signaturePhoto | object | CompanyAsset | Optional |
| member.contracts[].signaturePhoto.active | boolean | Optional | |
| member.contracts[].signaturePhoto.assetType | string |
Possible values are:
|
Optional |
| member.contracts[].signaturePhoto.companyId | string | Optional | |
| member.contracts[].signaturePhoto.created | int64 | Optional | |
| member.contracts[].signaturePhoto.deleted | boolean | Optional | |
| member.contracts[].signaturePhoto.id | string | Optional | |
| member.contracts[].signaturePhoto.key | string | Optional | |
| member.contracts[].signaturePhoto.largeURL | string | Optional | |
| member.contracts[].signaturePhoto.largeX2URL | string | Optional | |
| member.contracts[].signaturePhoto.mediumURL | string | Optional | |
| member.contracts[].signaturePhoto.modified | int64 | Optional | |
| member.contracts[].signaturePhoto.name | string | Optional | |
| member.contracts[].signaturePhoto.origURL | string | Optional | |
| member.contracts[].signaturePhoto.priority | int32 | Optional | |
| member.contracts[].signaturePhoto.publicURL | string | Optional | |
| member.contracts[].signaturePhoto.secured | boolean | Optional | |
| member.contracts[].signaturePhoto.thumbURL | string | Optional | |
| member.contracts[].signaturePhoto.type | string |
Possible values are:
|
Optional |
| member.contracts[].signaturePhoto.updated | boolean | Optional | |
| member.contracts[].signedDate | int64 | Optional | |
| member.contracts[].signedDigitally | boolean | Optional | |
| member.contracts[].updated | boolean | Optional | |
| member.contracts[].witnessName | string | Optional | |
| member.contracts[].witnessSignaturePhoto | object | CompanyAsset | Optional |
| member.contracts[].witnessSignaturePhoto.active | boolean | Optional | |
| member.contracts[].witnessSignaturePhoto.assetType | string |
Possible values are:
|
Optional |
| member.contracts[].witnessSignaturePhoto.companyId | string | Optional | |
| member.contracts[].witnessSignaturePhoto.created | int64 | Optional | |
| member.contracts[].witnessSignaturePhoto.deleted | boolean | Optional | |
| member.contracts[].witnessSignaturePhoto.id | string | Optional | |
| member.contracts[].witnessSignaturePhoto.key | string | Optional | |
| member.contracts[].witnessSignaturePhoto.largeURL | string | Optional | |
| member.contracts[].witnessSignaturePhoto.largeX2URL | string | Optional | |
| member.contracts[].witnessSignaturePhoto.mediumURL | string | Optional | |
| member.contracts[].witnessSignaturePhoto.modified | int64 | Optional | |
| member.contracts[].witnessSignaturePhoto.name | string | Optional | |
| member.contracts[].witnessSignaturePhoto.origURL | string | Optional | |
| member.contracts[].witnessSignaturePhoto.priority | int32 | Optional | |
| member.contracts[].witnessSignaturePhoto.publicURL | string | Optional | |
| member.contracts[].witnessSignaturePhoto.secured | boolean | Optional | |
| member.contracts[].witnessSignaturePhoto.thumbURL | string | Optional | |
| member.contracts[].witnessSignaturePhoto.type | string |
Possible values are:
|
Optional |
| member.contracts[].witnessSignaturePhoto.updated | boolean | Optional | |
| member.cpn | string | Optional | |
| member.created | int64 | Optional | |
| member.deleted | boolean | Optional | |
| member.dirty | boolean | Optional | |
| member.dlExpired | boolean | Optional | |
| member.dob | int64 | Optional | |
| member.email | string | Optional | |
| member.emailOptIn | boolean | Optional | |
| member.emailVerified | boolean | Optional | |
| member.enableLoyalty | boolean | Optional | |
| member.enabledCareGiver | boolean | Optional | |
| member.expStatuses[] | array of string | Optional | |
| member.firstName | string | Optional | |
| member.id | string | Optional | |
| member.identifications[] | array | Optional | |
| member.identifications[].assets[] | array | Optional | |
| member.identifications[].assets[].active | boolean | Optional | |
| member.identifications[].assets[].assetType | string |
Possible values are:
|
Optional |
| member.identifications[].assets[].companyId | string | Optional | |
| member.identifications[].assets[].created | int64 | Optional | |
| member.identifications[].assets[].deleted | boolean | Optional | |
| member.identifications[].assets[].id | string | Optional | |
| member.identifications[].assets[].key | string | Optional | |
| member.identifications[].assets[].largeURL | string | Optional | |
| member.identifications[].assets[].largeX2URL | string | Optional | |
| member.identifications[].assets[].mediumURL | string | Optional | |
| member.identifications[].assets[].modified | int64 | Optional | |
| member.identifications[].assets[].name | string | Optional | |
| member.identifications[].assets[].origURL | string | Optional | |
| member.identifications[].assets[].priority | int32 | Optional | |
| member.identifications[].assets[].publicURL | string | Optional | |
| member.identifications[].assets[].secured | boolean | Optional | |
| member.identifications[].assets[].thumbURL | string | Optional | |
| member.identifications[].assets[].type | string |
Possible values are:
|
Optional |
| member.identifications[].assets[].updated | boolean | Optional | |
| member.identifications[].companyId | string | Optional | |
| member.identifications[].created | int64 | Optional | |
| member.identifications[].deleted | boolean | Optional | |
| member.identifications[].expirationDate | int64 | Optional | |
| member.identifications[].frontPhoto | object | CompanyAsset | Optional |
| member.identifications[].frontPhoto.active | boolean | Optional | |
| member.identifications[].frontPhoto.assetType | string |
Possible values are:
|
Optional |
| member.identifications[].frontPhoto.companyId | string | Optional | |
| member.identifications[].frontPhoto.created | int64 | Optional | |
| member.identifications[].frontPhoto.deleted | boolean | Optional | |
| member.identifications[].frontPhoto.id | string | Optional | |
| member.identifications[].frontPhoto.key | string | Optional | |
| member.identifications[].frontPhoto.largeURL | string | Optional | |
| member.identifications[].frontPhoto.largeX2URL | string | Optional | |
| member.identifications[].frontPhoto.mediumURL | string | Optional | |
| member.identifications[].frontPhoto.modified | int64 | Optional | |
| member.identifications[].frontPhoto.name | string | Optional | |
| member.identifications[].frontPhoto.origURL | string | Optional | |
| member.identifications[].frontPhoto.priority | int32 | Optional | |
| member.identifications[].frontPhoto.publicURL | string | Optional | |
| member.identifications[].frontPhoto.secured | boolean | Optional | |
| member.identifications[].frontPhoto.thumbURL | string | Optional | |
| member.identifications[].frontPhoto.type | string |
Possible values are:
|
Optional |
| member.identifications[].frontPhoto.updated | boolean | Optional | |
| member.identifications[].id | string | Optional | |
| member.identifications[].licenseNumber | string | Optional | |
| member.identifications[].modified | int64 | Optional | |
| member.identifications[].state | string | Optional | |
| member.identifications[].type | string |
Possible values are:
|
Optional |
| member.identifications[].updated | boolean | Optional | |
| member.identifications[].verified | boolean | Optional | |
| member.importId | string | Optional | |
| member.lastName | string | Optional | |
| member.lastVisitDate | int64 | Optional | |
| member.lastestRecommendation | object | Recommendation | Optional |
| member.lastestRecommendation.assets[] | array | Optional | |
| member.lastestRecommendation.assets[].active | boolean | Optional | |
| member.lastestRecommendation.assets[].assetType | string |
Possible values are:
|
Optional |
| member.lastestRecommendation.assets[].companyId | string | Optional | |
| member.lastestRecommendation.assets[].created | int64 | Optional | |
| member.lastestRecommendation.assets[].deleted | boolean | Optional | |
| member.lastestRecommendation.assets[].id | string | Optional | |
| member.lastestRecommendation.assets[].key | string | Optional | |
| member.lastestRecommendation.assets[].largeURL | string | Optional | |
| member.lastestRecommendation.assets[].largeX2URL | string | Optional | |
| member.lastestRecommendation.assets[].mediumURL | string | Optional | |
| member.lastestRecommendation.assets[].modified | int64 | Optional | |
| member.lastestRecommendation.assets[].name | string | Optional | |
| member.lastestRecommendation.assets[].origURL | string | Optional | |
| member.lastestRecommendation.assets[].priority | int32 | Optional | |
| member.lastestRecommendation.assets[].publicURL | string | Optional | |
| member.lastestRecommendation.assets[].secured | boolean | Optional | |
| member.lastestRecommendation.assets[].thumbURL | string | Optional | |
| member.lastestRecommendation.assets[].type | string |
Possible values are:
|
Optional |
| member.lastestRecommendation.assets[].updated | boolean | Optional | |
| member.lastestRecommendation.companyId | string | Optional | |
| member.lastestRecommendation.created | int64 | Optional | |
| member.lastestRecommendation.deleted | boolean | Optional | |
| member.lastestRecommendation.doctor | object | Doctor | Optional |
| member.lastestRecommendation.doctor.active | boolean | Optional | |
| member.lastestRecommendation.doctor.address | object | Address | Optional |
| member.lastestRecommendation.doctor.address.address | string | Optional | |
| member.lastestRecommendation.doctor.address.addressLine2 | string | Optional | |
| member.lastestRecommendation.doctor.address.city | string | Optional | |
| member.lastestRecommendation.doctor.address.companyId | string | Optional | |
| member.lastestRecommendation.doctor.address.country | string | Optional | |
| member.lastestRecommendation.doctor.address.created | int64 | Optional | |
| member.lastestRecommendation.doctor.address.deleted | boolean | Optional | |
| member.lastestRecommendation.doctor.address.id | string | Optional | |
| member.lastestRecommendation.doctor.address.latitude | number | Optional | |
| member.lastestRecommendation.doctor.address.longitude | number | Optional | |
| member.lastestRecommendation.doctor.address.modified | int64 | Optional | |
| member.lastestRecommendation.doctor.address.state | string | Optional | |
| member.lastestRecommendation.doctor.address.updated | boolean | Optional | |
| member.lastestRecommendation.doctor.address.zipCode | string | Optional | |
| member.lastestRecommendation.doctor.assets[] | array | Optional | |
| member.lastestRecommendation.doctor.assets[].active | boolean | Optional | |
| member.lastestRecommendation.doctor.assets[].assetType | string |
Possible values are:
|
Optional |
| member.lastestRecommendation.doctor.assets[].companyId | string | Optional | |
| member.lastestRecommendation.doctor.assets[].created | int64 | Optional | |
| member.lastestRecommendation.doctor.assets[].deleted | boolean | Optional | |
| member.lastestRecommendation.doctor.assets[].id | string | Optional | |
| member.lastestRecommendation.doctor.assets[].key | string | Optional | |
| member.lastestRecommendation.doctor.assets[].largeURL | string | Optional | |
| member.lastestRecommendation.doctor.assets[].largeX2URL | string | Optional | |
| member.lastestRecommendation.doctor.assets[].mediumURL | string | Optional | |
| member.lastestRecommendation.doctor.assets[].modified | int64 | Optional | |
| member.lastestRecommendation.doctor.assets[].name | string | Optional | |
| member.lastestRecommendation.doctor.assets[].origURL | string | Optional | |
| member.lastestRecommendation.doctor.assets[].priority | int32 | Optional | |
| member.lastestRecommendation.doctor.assets[].publicURL | string | Optional | |
| member.lastestRecommendation.doctor.assets[].secured | boolean | Optional | |
| member.lastestRecommendation.doctor.assets[].thumbURL | string | Optional | |
| member.lastestRecommendation.doctor.assets[].type | string |
Possible values are:
|
Optional |
| member.lastestRecommendation.doctor.assets[].updated | boolean | Optional | |
| member.lastestRecommendation.doctor.companyId | string | Optional | |
| member.lastestRecommendation.doctor.created | int64 | Optional | |
| member.lastestRecommendation.doctor.degree | string | Optional | |
| member.lastestRecommendation.doctor.deleted | boolean | Optional | |
| member.lastestRecommendation.doctor.email | string | Optional | |
| member.lastestRecommendation.doctor.fax | string | Optional | |
| member.lastestRecommendation.doctor.firstName | string | Optional | |
| member.lastestRecommendation.doctor.id | string | Optional | |
| member.lastestRecommendation.doctor.importId | string | Optional | |
| member.lastestRecommendation.doctor.lastName | string | Optional | |
| member.lastestRecommendation.doctor.license | string | Optional | |
| member.lastestRecommendation.doctor.modified | int64 | Optional | |
| member.lastestRecommendation.doctor.notes[] | array | Optional | |
| member.lastestRecommendation.doctor.notes[].created | int64 | Optional | |
| member.lastestRecommendation.doctor.notes[].deleted | boolean | Optional | |
| member.lastestRecommendation.doctor.notes[].enableOnFleet | boolean | Optional | |
| member.lastestRecommendation.doctor.notes[].id | string | Optional | |
| member.lastestRecommendation.doctor.notes[].message | string | Optional | |
| member.lastestRecommendation.doctor.notes[].modified | int64 | Optional | |
| member.lastestRecommendation.doctor.notes[].updated | boolean | Optional | |
| member.lastestRecommendation.doctor.notes[].writerId | string | Optional | |
| member.lastestRecommendation.doctor.notes[].writerName | string | Optional | |
| member.lastestRecommendation.doctor.phoneNumber | string | Optional | |
| member.lastestRecommendation.doctor.searchText | string | Optional | |
| member.lastestRecommendation.doctor.state | string | Optional | |
| member.lastestRecommendation.doctor.updated | boolean | Optional | |
| member.lastestRecommendation.doctor.website | string | Optional | |
| member.lastestRecommendation.doctorId | string | Optional | |
| member.lastestRecommendation.expirationDate | int64 | Optional | |
| member.lastestRecommendation.frontPhoto | object | CompanyAsset | Optional |
| member.lastestRecommendation.frontPhoto.active | boolean | Optional | |
| member.lastestRecommendation.frontPhoto.assetType | string |
Possible values are:
|
Optional |
| member.lastestRecommendation.frontPhoto.companyId | string | Optional | |
| member.lastestRecommendation.frontPhoto.created | int64 | Optional | |
| member.lastestRecommendation.frontPhoto.deleted | boolean | Optional | |
| member.lastestRecommendation.frontPhoto.id | string | Optional | |
| member.lastestRecommendation.frontPhoto.key | string | Optional | |
| member.lastestRecommendation.frontPhoto.largeURL | string | Optional | |
| member.lastestRecommendation.frontPhoto.largeX2URL | string | Optional | |
| member.lastestRecommendation.frontPhoto.mediumURL | string | Optional | |
| member.lastestRecommendation.frontPhoto.modified | int64 | Optional | |
| member.lastestRecommendation.frontPhoto.name | string | Optional | |
| member.lastestRecommendation.frontPhoto.origURL | string | Optional | |
| member.lastestRecommendation.frontPhoto.priority | int32 | Optional | |
| member.lastestRecommendation.frontPhoto.publicURL | string | Optional | |
| member.lastestRecommendation.frontPhoto.secured | boolean | Optional | |
| member.lastestRecommendation.frontPhoto.thumbURL | string | Optional | |
| member.lastestRecommendation.frontPhoto.type | string |
Possible values are:
|
Optional |
| member.lastestRecommendation.frontPhoto.updated | boolean | Optional | |
| member.lastestRecommendation.id | string | Optional | |
| member.lastestRecommendation.issueDate | int64 | Optional | |
| member.lastestRecommendation.limitExemption | boolean | Optional | |
| member.lastestRecommendation.modified | int64 | Optional | |
| member.lastestRecommendation.recommendationNumber | string | Optional | |
| member.lastestRecommendation.state | string | Optional | |
| member.lastestRecommendation.temporary | boolean | Optional | |
| member.lastestRecommendation.updated | boolean | Optional | |
| member.lastestRecommendation.verified | boolean | Optional | |
| member.lastestRecommendation.verifyMethod | string |
Possible values are:
|
Optional |
| member.lastestRecommendation.verifyPhoneNumber | string | Optional | |
| member.lastestRecommendation.verifyWebsite | string | Optional | |
| member.lifetimePoints | number | Optional | |
| member.loyaltyPoints | number | Optional | |
| member.marketingSource | string | Optional | |
| member.medical | boolean | Optional | |
| member.memberGroup | object | MemberGroup | Optional |
| member.memberGroup.active | boolean | Optional | |
| member.memberGroup.companyId | string | Optional | |
| member.memberGroup.created | int64 | Optional | |
| member.memberGroup.defaultGroup | boolean | Optional | |
| member.memberGroup.deleted | boolean | Optional | |
| member.memberGroup.dirty | boolean | Optional | |
| member.memberGroup.discount | number | Optional | |
| member.memberGroup.discountType | string |
Possible values are:
|
Optional |
| member.memberGroup.enablePromotion | boolean | Optional | |
| member.memberGroup.id | string | Optional | |
| member.memberGroup.memberCount | int32 | Optional | |
| member.memberGroup.memberCountEmailOptIn | int32 | Optional | |
| member.memberGroup.memberCountTextOptIn | int32 | Optional | |
| member.memberGroup.modified | int64 | Optional | |
| member.memberGroup.name | string | Optional | |
| member.memberGroup.promotionId | string | Optional | |
| member.memberGroup.promotionShopMap | object | Optional | |
| member.memberGroup.promotionShopMap.<key> | map of string | Optional | |
| member.memberGroup.shopId | string | Optional | |
| member.memberGroup.updated | boolean | Optional | |
| member.memberGroupId | string | Optional | |
| member.middleName | string | Optional | |
| member.modified | int64 | Optional | |
| member.notes[] | array | Optional | |
| member.notes[].created | int64 | Optional | |
| member.notes[].deleted | boolean | Optional | |
| member.notes[].enableOnFleet | boolean | Optional | |
| member.notes[].id | string | Optional | |
| member.notes[].message | string | Optional | |
| member.notes[].modified | int64 | Optional | |
| member.notes[].updated | boolean | Optional | |
| member.notes[].writerId | string | Optional | |
| member.notes[].writerName | string | Optional | |
| member.preferences[] | array | Optional | |
| member.preferences[].companyId | string | Optional | |
| member.preferences[].created | int64 | Optional | |
| member.preferences[].deleted | boolean | Optional | |
| member.preferences[].id | string | Optional | |
| member.preferences[].modified | int64 | Optional | |
| member.preferences[].name | string | Optional | |
| member.preferences[].updated | boolean | Optional | |
| member.primaryPhone | string | Optional | |
| member.qbCustomerRef[] | array of object | Optional | |
| member.qbCustomerRef[].<key> | map of string | Optional | |
| member.recentProducts[] | array of string | Optional | |
| member.recommendationExpired | boolean | Optional | |
| member.recommendationExpiryLeft | int64 | Optional | |
| member.recommendations[] | array | Optional | |
| member.recommendations[].assets[] | array | Optional | |
| member.recommendations[].assets[].active | boolean | Optional | |
| member.recommendations[].assets[].assetType | string |
Possible values are:
|
Optional |
| member.recommendations[].assets[].companyId | string | Optional | |
| member.recommendations[].assets[].created | int64 | Optional | |
| member.recommendations[].assets[].deleted | boolean | Optional | |
| member.recommendations[].assets[].id | string | Optional | |
| member.recommendations[].assets[].key | string | Optional | |
| member.recommendations[].assets[].largeURL | string | Optional | |
| member.recommendations[].assets[].largeX2URL | string | Optional | |
| member.recommendations[].assets[].mediumURL | string | Optional | |
| member.recommendations[].assets[].modified | int64 | Optional | |
| member.recommendations[].assets[].name | string | Optional | |
| member.recommendations[].assets[].origURL | string | Optional | |
| member.recommendations[].assets[].priority | int32 | Optional | |
| member.recommendations[].assets[].publicURL | string | Optional | |
| member.recommendations[].assets[].secured | boolean | Optional | |
| member.recommendations[].assets[].thumbURL | string | Optional | |
| member.recommendations[].assets[].type | string |
Possible values are:
|
Optional |
| member.recommendations[].assets[].updated | boolean | Optional | |
| member.recommendations[].companyId | string | Optional | |
| member.recommendations[].created | int64 | Optional | |
| member.recommendations[].deleted | boolean | Optional | |
| member.recommendations[].doctor | object | Doctor | Optional |
| member.recommendations[].doctor.active | boolean | Optional | |
| member.recommendations[].doctor.address | object | Address | Optional |
| member.recommendations[].doctor.address.address | string | Optional | |
| member.recommendations[].doctor.address.addressLine2 | string | Optional | |
| member.recommendations[].doctor.address.city | string | Optional | |
| member.recommendations[].doctor.address.companyId | string | Optional | |
| member.recommendations[].doctor.address.country | string | Optional | |
| member.recommendations[].doctor.address.created | int64 | Optional | |
| member.recommendations[].doctor.address.deleted | boolean | Optional | |
| member.recommendations[].doctor.address.id | string | Optional | |
| member.recommendations[].doctor.address.latitude | number | Optional | |
| member.recommendations[].doctor.address.longitude | number | Optional | |
| member.recommendations[].doctor.address.modified | int64 | Optional | |
| member.recommendations[].doctor.address.state | string | Optional | |
| member.recommendations[].doctor.address.updated | boolean | Optional | |
| member.recommendations[].doctor.address.zipCode | string | Optional | |
| member.recommendations[].doctor.assets[] | array | Optional | |
| member.recommendations[].doctor.assets[].active | boolean | Optional | |
| member.recommendations[].doctor.assets[].assetType | string |
Possible values are:
|
Optional |
| member.recommendations[].doctor.assets[].companyId | string | Optional | |
| member.recommendations[].doctor.assets[].created | int64 | Optional | |
| member.recommendations[].doctor.assets[].deleted | boolean | Optional | |
| member.recommendations[].doctor.assets[].id | string | Optional | |
| member.recommendations[].doctor.assets[].key | string | Optional | |
| member.recommendations[].doctor.assets[].largeURL | string | Optional | |
| member.recommendations[].doctor.assets[].largeX2URL | string | Optional | |
| member.recommendations[].doctor.assets[].mediumURL | string | Optional | |
| member.recommendations[].doctor.assets[].modified | int64 | Optional | |
| member.recommendations[].doctor.assets[].name | string | Optional | |
| member.recommendations[].doctor.assets[].origURL | string | Optional | |
| member.recommendations[].doctor.assets[].priority | int32 | Optional | |
| member.recommendations[].doctor.assets[].publicURL | string | Optional | |
| member.recommendations[].doctor.assets[].secured | boolean | Optional | |
| member.recommendations[].doctor.assets[].thumbURL | string | Optional | |
| member.recommendations[].doctor.assets[].type | string |
Possible values are:
|
Optional |
| member.recommendations[].doctor.assets[].updated | boolean | Optional | |
| member.recommendations[].doctor.companyId | string | Optional | |
| member.recommendations[].doctor.created | int64 | Optional | |
| member.recommendations[].doctor.degree | string | Optional | |
| member.recommendations[].doctor.deleted | boolean | Optional | |
| member.recommendations[].doctor.email | string | Optional | |
| member.recommendations[].doctor.fax | string | Optional | |
| member.recommendations[].doctor.firstName | string | Optional | |
| member.recommendations[].doctor.id | string | Optional | |
| member.recommendations[].doctor.importId | string | Optional | |
| member.recommendations[].doctor.lastName | string | Optional | |
| member.recommendations[].doctor.license | string | Optional | |
| member.recommendations[].doctor.modified | int64 | Optional | |
| member.recommendations[].doctor.notes[] | array | Optional | |
| member.recommendations[].doctor.notes[].created | int64 | Optional | |
| member.recommendations[].doctor.notes[].deleted | boolean | Optional | |
| member.recommendations[].doctor.notes[].enableOnFleet | boolean | Optional | |
| member.recommendations[].doctor.notes[].id | string | Optional | |
| member.recommendations[].doctor.notes[].message | string | Optional | |
| member.recommendations[].doctor.notes[].modified | int64 | Optional | |
| member.recommendations[].doctor.notes[].updated | boolean | Optional | |
| member.recommendations[].doctor.notes[].writerId | string | Optional | |
| member.recommendations[].doctor.notes[].writerName | string | Optional | |
| member.recommendations[].doctor.phoneNumber | string | Optional | |
| member.recommendations[].doctor.searchText | string | Optional | |
| member.recommendations[].doctor.state | string | Optional | |
| member.recommendations[].doctor.updated | boolean | Optional | |
| member.recommendations[].doctor.website | string | Optional | |
| member.recommendations[].doctorId | string | Optional | |
| member.recommendations[].expirationDate | int64 | Optional | |
| member.recommendations[].frontPhoto | object | CompanyAsset | Optional |
| member.recommendations[].frontPhoto.active | boolean | Optional | |
| member.recommendations[].frontPhoto.assetType | string |
Possible values are:
|
Optional |
| member.recommendations[].frontPhoto.companyId | string | Optional | |
| member.recommendations[].frontPhoto.created | int64 | Optional | |
| member.recommendations[].frontPhoto.deleted | boolean | Optional | |
| member.recommendations[].frontPhoto.id | string | Optional | |
| member.recommendations[].frontPhoto.key | string | Optional | |
| member.recommendations[].frontPhoto.largeURL | string | Optional | |
| member.recommendations[].frontPhoto.largeX2URL | string | Optional | |
| member.recommendations[].frontPhoto.mediumURL | string | Optional | |
| member.recommendations[].frontPhoto.modified | int64 | Optional | |
| member.recommendations[].frontPhoto.name | string | Optional | |
| member.recommendations[].frontPhoto.origURL | string | Optional | |
| member.recommendations[].frontPhoto.priority | int32 | Optional | |
| member.recommendations[].frontPhoto.publicURL | string | Optional | |
| member.recommendations[].frontPhoto.secured | boolean | Optional | |
| member.recommendations[].frontPhoto.thumbURL | string | Optional | |
| member.recommendations[].frontPhoto.type | string |
Possible values are:
|
Optional |
| member.recommendations[].frontPhoto.updated | boolean | Optional | |
| member.recommendations[].id | string | Optional | |
| member.recommendations[].issueDate | int64 | Optional | |
| member.recommendations[].limitExemption | boolean | Optional | |
| member.recommendations[].modified | int64 | Optional | |
| member.recommendations[].recommendationNumber | string | Optional | |
| member.recommendations[].state | string | Optional | |
| member.recommendations[].temporary | boolean | Optional | |
| member.recommendations[].updated | boolean | Optional | |
| member.recommendations[].verified | boolean | Optional | |
| member.recommendations[].verifyMethod | string |
Possible values are:
|
Optional |
| member.recommendations[].verifyPhoneNumber | string | Optional | |
| member.recommendations[].verifyWebsite | string | Optional | |
| member.regionId | string | Optional | |
| member.searchText | string | Optional | |
| member.sex | string |
Possible values are:
|
Optional |
| member.shopId | string | Optional | |
| member.startDate | int64 | Optional | |
| member.status | string |
Possible values are:
|
Optional |
| member.tags[] | array of string | Optional | |
| member.textOptIn | boolean | Optional | |
| member.updated | boolean | Optional | |
| member.uppercaseCity | string | Optional | |
| memberId | string | Optional | |
| memberSignature | object | CompanyAsset | Optional |
| memberSignature.active | boolean | Optional | |
| memberSignature.assetType | string |
Possible values are:
|
Optional |
| memberSignature.companyId | string | Optional | |
| memberSignature.created | int64 | Optional | |
| memberSignature.deleted | boolean | Optional | |
| memberSignature.id | string | Optional | |
| memberSignature.key | string | Optional | |
| memberSignature.largeURL | string | Optional | |
| memberSignature.largeX2URL | string | Optional | |
| memberSignature.mediumURL | string | Optional | |
| memberSignature.modified | int64 | Optional | |
| memberSignature.name | string | Optional | |
| memberSignature.origURL | string | Optional | |
| memberSignature.priority | int32 | Optional | |
| memberSignature.publicURL | string | Optional | |
| memberSignature.secured | boolean | Optional | |
| memberSignature.thumbURL | string | Optional | |
| memberSignature.type | string |
Possible values are:
|
Optional |
| memberSignature.updated | boolean | Optional | |
| memo | string | Optional | |
| message | string | Optional | |
| metrcDeliveryId | int64 | Optional | |
| metrcDeliverySubmitStatus | string |
Possible values are:
|
Optional |
| metrcDeliverySubmitTime | int64 | Optional | |
| metrcId | int64 | Optional | |
| metrcSaleTime | string | Optional | |
| metrcSubmissionCompleteTime | int64 | Optional | |
| metrcSubmissionDeleteTime | int64 | Optional | |
| mileage | number | Optional | |
| mileageCalculated | boolean | Optional | |
| modified | int64 | Optional | |
| mtracTxnId | string | Optional | |
| note | object | Note | Optional |
| note.created | int64 | Optional | |
| note.deleted | boolean | Optional | |
| note.enableOnFleet | boolean | Optional | |
| note.id | string | Optional | |
| note.message | string | Optional | |
| note.modified | int64 | Optional | |
| note.updated | boolean | Optional | |
| note.writerId | string | Optional | |
| note.writerName | string | Optional | |
| onFleetError | string | Optional | |
| onFleetTaskId | string | Optional | |
| onFleetTaskStatus | string |
Possible values are:
|
Optional |
| onFleetTeamId | string | Optional | |
| onfleetTwoWaySuccess | boolean | Optional | |
| orderTags[] | array of string | Optional | |
| overrideInventoryId | string | Optional | |
| packedBy | string | Optional | |
| packedByEmployee | object | Employee | Optional |
| packedByEmployee.address | object | Address | Optional |
| packedByEmployee.address.address | string | Optional | |
| packedByEmployee.address.addressLine2 | string | Optional | |
| packedByEmployee.address.city | string | Optional | |
| packedByEmployee.address.companyId | string | Optional | |
| packedByEmployee.address.country | string | Optional | |
| packedByEmployee.address.created | int64 | Optional | |
| packedByEmployee.address.deleted | boolean | Optional | |
| packedByEmployee.address.id | string | Optional | |
| packedByEmployee.address.latitude | number | Optional | |
| packedByEmployee.address.longitude | number | Optional | |
| packedByEmployee.address.modified | int64 | Optional | |
| packedByEmployee.address.state | string | Optional | |
| packedByEmployee.address.updated | boolean | Optional | |
| packedByEmployee.address.zipCode | string | Optional | |
| packedByEmployee.appAccessList[] | array of string |
Possible values are:
|
Optional |
| packedByEmployee.assignedInventoryId | string | Optional | |
| packedByEmployee.assignedTerminalId | string | Optional | |
| packedByEmployee.canApplyCustomDiscount | boolean | Optional | |
| packedByEmployee.cashDrawerStatus | string |
Possible values are:
|
Optional |
| packedByEmployee.companyId | string | Optional | |
| packedByEmployee.created | int64 | Optional | |
| packedByEmployee.deleted | boolean | Optional | |
| packedByEmployee.disabled | boolean | Optional | |
| packedByEmployee.dlExpirationDate | string | Optional | |
| packedByEmployee.driver | boolean | Optional | |
| packedByEmployee.driversLicense | string | Optional | |
| packedByEmployee.email | string | Optional | |
| packedByEmployee.employeeOnFleetInfoList[] | array | Optional | |
| packedByEmployee.employeeOnFleetInfoList[].onFleetTeamList[] | array of string | Optional | |
| packedByEmployee.employeeOnFleetInfoList[].onFleetWorkerId | string | Optional | |
| packedByEmployee.employeeOnFleetInfoList[].shopId | string | Optional | |
| packedByEmployee.externalId | string | Optional | |
| packedByEmployee.firstName | string | Optional | |
| packedByEmployee.id | string | Optional | |
| packedByEmployee.insuranceCompanyName | string | Optional | |
| packedByEmployee.insuranceExpireDate | int64 | Optional | |
| packedByEmployee.inventoryName | string | Optional | |
| packedByEmployee.lastLoggedInShopId | string | Optional | |
| packedByEmployee.lastLoginTime | int64 | Optional | |
| packedByEmployee.lastName | string | Optional | |
| packedByEmployee.modified | int64 | Optional | |
| packedByEmployee.notes[] | array | Optional | |
| packedByEmployee.notes[].created | int64 | Optional | |
| packedByEmployee.notes[].deleted | boolean | Optional | |
| packedByEmployee.notes[].enableOnFleet | boolean | Optional | |
| packedByEmployee.notes[].id | string | Optional | |
| packedByEmployee.notes[].message | string | Optional | |
| packedByEmployee.notes[].modified | int64 | Optional | |
| packedByEmployee.notes[].updated | boolean | Optional | |
| packedByEmployee.notes[].writerId | string | Optional | |
| packedByEmployee.notes[].writerName | string | Optional | |
| packedByEmployee.occupationLicenseNumber | string | Optional | |
| packedByEmployee.organizationIds[] | array of string | Optional | |
| packedByEmployee.password | string | Optional | |
| packedByEmployee.phoneNumber | string | Optional | |
| packedByEmployee.pin | string | Optional | |
| packedByEmployee.policyNumber | string | Optional | |
| packedByEmployee.recentLocation | object | TerminalLocation | Optional |
| packedByEmployee.recentLocation.companyId | string | Optional | |
| packedByEmployee.recentLocation.created | int64 | Optional | |
| packedByEmployee.recentLocation.deleted | boolean | Optional | |
| packedByEmployee.recentLocation.deviceId | string | Optional | |
| packedByEmployee.recentLocation.dirty | boolean | Optional | |
| packedByEmployee.recentLocation.employeeId | string | Optional | |
| packedByEmployee.recentLocation.id | string | Optional | |
| packedByEmployee.recentLocation.loc[] | array of double | Optional | |
| packedByEmployee.recentLocation.modified | int64 | Optional | |
| packedByEmployee.recentLocation.name | string | Optional | |
| packedByEmployee.recentLocation.shopId | string | Optional | |
| packedByEmployee.recentLocation.terminalId | string | Optional | |
| packedByEmployee.recentLocation.timeCardId | string | Optional | |
| packedByEmployee.recentLocation.updated | boolean | Optional | |
| packedByEmployee.registrationExpireDate | int64 | Optional | |
| packedByEmployee.role | object | Role | Optional |
| packedByEmployee.role.companyId | string | Optional | |
| packedByEmployee.role.created | int64 | Optional | |
| packedByEmployee.role.deleted | boolean | Optional | |
| packedByEmployee.role.id | string | Optional | |
| packedByEmployee.role.modified | int64 | Optional | |
| packedByEmployee.role.name | string | Optional | |
| packedByEmployee.role.permissions[] | array of string |
Possible values are:
|
Optional |
| packedByEmployee.role.updated | boolean | Optional | |
| packedByEmployee.roleId | string | Optional | |
| packedByEmployee.shops[] | array of string | Optional | |
| packedByEmployee.terminalName | string | Optional | |
| packedByEmployee.timeCard | object | TimeCard | Optional |
| packedByEmployee.timeCard.clockInTime | int64 | Optional | |
| packedByEmployee.timeCard.clockOutTime | int64 | Optional | |
| packedByEmployee.timeCard.clockin | boolean | Optional | |
| packedByEmployee.timeCard.companyId | string | Optional | |
| packedByEmployee.timeCard.created | int64 | Optional | |
| packedByEmployee.timeCard.deleted | boolean | Optional | |
| packedByEmployee.timeCard.dirty | boolean | Optional | |
| packedByEmployee.timeCard.employeeId | string | Optional | |
| packedByEmployee.timeCard.id | string | Optional | |
| packedByEmployee.timeCard.modified | int64 | Optional | |
| packedByEmployee.timeCard.sessions[] | array | Optional | |
| packedByEmployee.timeCard.sessions[].companyId | string | Optional | |
| packedByEmployee.timeCard.sessions[].created | int64 | Optional | |
| packedByEmployee.timeCard.sessions[].deleted | boolean | Optional | |
| packedByEmployee.timeCard.sessions[].dirty | boolean | Optional | |
| packedByEmployee.timeCard.sessions[].employeeId | string | Optional | |
| packedByEmployee.timeCard.sessions[].endTime | int64 | Optional | |
| packedByEmployee.timeCard.sessions[].id | string | Optional | |
| packedByEmployee.timeCard.sessions[].modified | int64 | Optional | |
| packedByEmployee.timeCard.sessions[].shopId | string | Optional | |
| packedByEmployee.timeCard.sessions[].startTime | int64 | Optional | |
| packedByEmployee.timeCard.sessions[].terminalId | string | Optional | |
| packedByEmployee.timeCard.sessions[].timeCardId | string | Optional | |
| packedByEmployee.timeCard.sessions[].updated | boolean | Optional | |
| packedByEmployee.timeCard.shopId | string | Optional | |
| packedByEmployee.timeCard.updated | boolean | Optional | |
| packedByEmployee.timecardId | string | Optional | |
| packedByEmployee.tookanInfoList[] | array | Optional | |
| packedByEmployee.tookanInfoList[].shopId | string | Optional | |
| packedByEmployee.tookanInfoList[].status | string |
Possible values are:
|
Optional |
| packedByEmployee.tookanInfoList[].teamId | string | Optional | |
| packedByEmployee.tookanInfoList[].tookanAgentId | string | Optional | |
| packedByEmployee.updated | boolean | Optional | |
| packedByEmployee.vehicleLicensePlate | string | Optional | |
| packedByEmployee.vehicleMake | string | Optional | |
| packedByEmployee.vehicleModel | string | Optional | |
| packedByEmployee.vehiclePin | string | Optional | |
| packedByEmployee.vinNo | string | Optional | |
| packedDate | int64 | Optional | |
| paid | boolean | Optional | |
| paidAmount | number | Optional | |
| paidTime | int64 | Optional | |
| parentTransactionId | string | Optional | |
| payingWithPaymentCard | boolean | Optional | |
| paymentCardPayments[] | array | Optional | |
| paymentCardPayments[].amount | number | Optional | |
| paymentCardPayments[].balance | number | Optional | |
| paymentCardPayments[].cardEncrypted | string | Optional | |
| paymentCardPayments[].created | int64 | Optional | |
| paymentCardPayments[].currency | string | Optional | |
| paymentCardPayments[].cvv | string | Optional | |
| paymentCardPayments[].deleted | boolean | Optional | |
| paymentCardPayments[].email | string | Optional | |
| paymentCardPayments[].expMonth | int32 | Optional | |
| paymentCardPayments[].expYear | int32 | Optional | |
| paymentCardPayments[].exp_date | string | Optional | |
| paymentCardPayments[].first6 | string | Optional | |
| paymentCardPayments[].first_name | string | Optional | |
| paymentCardPayments[].id | string | Optional | |
| paymentCardPayments[].last4 | string | Optional | |
| paymentCardPayments[].last_name | string | Optional | |
| paymentCardPayments[].modified | int64 | Optional | |
| paymentCardPayments[].paymentCardNumber | string | Optional | |
| paymentCardPayments[].paymentId | string | Optional | |
| paymentCardPayments[].phone_number | string | Optional | |
| paymentCardPayments[].processedTime | int64 | Optional | |
| paymentCardPayments[].status | string |
Possible values are:
|
Optional |
| paymentCardPayments[].statusMessage | string | Optional | |
| paymentCardPayments[].type | string |
Possible values are:
|
Optional |
| paymentCardPayments[].updated | boolean | Optional | |
| paymentEditedBy | string | Optional | |
| paymentEditedTime | int64 | Optional | |
| paymentReceived | number | Optional | |
| payments[] | array | Optional | |
| payments[].amount | number | Optional | |
| payments[].batchNum | int32 | Optional | |
| payments[].calculatedAmount | number | Optional | |
| payments[].cardFee | number | Optional | |
| payments[].cardFeesLog | object | CardFeesLog | Optional |
| payments[].cardFeesLog.companyId | string | Optional | |
| payments[].cardFeesLog.created | int64 | Optional | |
| payments[].cardFeesLog.deleted | boolean | Optional | |
| payments[].cardFeesLog.dirty | boolean | Optional | |
| payments[].cardFeesLog.enabled | boolean | Optional | |
| payments[].cardFeesLog.fee | number | Optional | |
| payments[].cardFeesLog.feeAmount | number | Optional | |
| payments[].cardFeesLog.feeType | string |
Possible values are:
|
Optional |
| payments[].cardFeesLog.id | string | Optional | |
| payments[].cardFeesLog.modified | int64 | Optional | |
| payments[].cardFeesLog.shopId | string | Optional | |
| payments[].cardFeesLog.subTotalThreshold | number | Optional | |
| payments[].cardFeesLog.type | string |
Possible values are:
|
Optional |
| payments[].cardFeesLog.updated | boolean | Optional | |
| payments[].cashBack | number | Optional | |
| payments[].changeDue | number | Optional | |
| payments[].companyId | string | Optional | |
| payments[].created | int64 | Optional | |
| payments[].deleted | boolean | Optional | |
| payments[].dirty | boolean | Optional | |
| payments[].id | string | Optional | |
| payments[].invNum | int32 | Optional | |
| payments[].manual | boolean | Optional | |
| payments[].modified | int64 | Optional | |
| payments[].paymentOption | string |
Possible values are:
|
Optional |
| payments[].paymentReceived | number | Optional | |
| payments[].posTerminal | object | DejavooTerminalConfig | Optional |
| payments[].posTerminal.authKey | string | Optional | |
| payments[].posTerminal.created | int64 | Optional | |
| payments[].posTerminal.deleted | boolean | Optional | |
| payments[].posTerminal.enabled | boolean | Optional | |
| payments[].posTerminal.id | string | Optional | |
| payments[].posTerminal.manual | boolean | Optional | |
| payments[].posTerminal.modified | int64 | Optional | |
| payments[].posTerminal.name | string | Optional | |
| payments[].posTerminal.online | boolean | Optional | |
| payments[].posTerminal.processors[] | array of int32 | Optional | |
| payments[].posTerminal.registerId | string | Optional | |
| payments[].posTerminal.serialNumber | string | Optional | |
| payments[].posTerminal.terminalId | string | Optional | |
| payments[].posTerminal.updated | boolean | Optional | |
| payments[].processor | int32 | Optional | |
| payments[].refID | string | Optional | |
| payments[].requestId | string | Optional | |
| payments[].shopId | string | Optional | |
| payments[].split | boolean | Optional | |
| payments[].terminal | object | Terminal | Optional |
| payments[].terminal.active | boolean | Optional | |
| payments[].terminal.appVersion | string | Optional | |
| payments[].terminal.assignedInventoryId | string | Optional | |
| payments[].terminal.checkoutType | string |
Possible values are:
|
Optional |
| payments[].terminal.companyId | string | Optional | |
| payments[].terminal.created | int64 | Optional | |
| payments[].terminal.creditCardReader | object | CreditCardReader | Optional |
| payments[].terminal.creditCardReader.encryptionType | string |
Possible values are:
|
Optional |
| payments[].terminal.creditCardReader.secretKey | string | Optional | |
| payments[].terminal.currentEmployeeId | string | Optional | |
| payments[].terminal.cvAccountId | string | Optional | |
| payments[].terminal.deleted | boolean | Optional | |
| payments[].terminal.deviceDetails[] | array | Optional | |
| payments[].terminal.deviceDetails[].active | boolean | Optional | |
| payments[].terminal.deviceDetails[].appType | string |
Possible values are:
|
Optional |
| payments[].terminal.deviceDetails[].deviceId | string | Optional | |
| payments[].terminal.deviceDetails[].deviceModel | string | Optional | |
| payments[].terminal.deviceDetails[].deviceName | string | Optional | |
| payments[].terminal.deviceDetails[].deviceToken | string | Optional | |
| payments[].terminal.deviceDetails[].deviceType | string |
Possible values are:
|
Optional |
| payments[].terminal.deviceDetails[].deviceVersion | string | Optional | |
| payments[].terminal.deviceDetails[].sdkVersion | string | Optional | |
| payments[].terminal.deviceDetails[].version | string | Optional | |
| payments[].terminal.deviceId | string | Optional | |
| payments[].terminal.deviceModel | string | Optional | |
| payments[].terminal.deviceName | string | Optional | |
| payments[].terminal.deviceToken | string | Optional | |
| payments[].terminal.deviceType | string | Optional | |
| payments[].terminal.deviceVersion | string | Optional | |
| payments[].terminal.dirty | boolean | Optional | |
| payments[].terminal.id | string | Optional | |
| payments[].terminal.modified | int64 | Optional | |
| payments[].terminal.name | string | Optional | |
| payments[].terminal.onPremEnabled | boolean | Optional | |
| payments[].terminal.posTerminal | string | Optional | |
| payments[].terminal.regionId | string | Optional | |
| payments[].terminal.shopId | string | Optional | |
| payments[].terminal.terminalLocations[] | array | Optional | |
| payments[].terminal.terminalLocations[].companyId | string | Optional | |
| payments[].terminal.terminalLocations[].created | int64 | Optional | |
| payments[].terminal.terminalLocations[].deleted | boolean | Optional | |
| payments[].terminal.terminalLocations[].deviceId | string | Optional | |
| payments[].terminal.terminalLocations[].dirty | boolean | Optional | |
| payments[].terminal.terminalLocations[].employeeId | string | Optional | |
| payments[].terminal.terminalLocations[].id | string | Optional | |
| payments[].terminal.terminalLocations[].loc[] | array of double | Optional | |
| payments[].terminal.terminalLocations[].modified | int64 | Optional | |
| payments[].terminal.terminalLocations[].name | string | Optional | |
| payments[].terminal.terminalLocations[].shopId | string | Optional | |
| payments[].terminal.terminalLocations[].terminalId | string | Optional | |
| payments[].terminal.terminalLocations[].timeCardId | string | Optional | |
| payments[].terminal.terminalLocations[].updated | boolean | Optional | |
| payments[].terminal.terminalType | string |
Possible values are:
|
Optional |
| payments[].terminal.updated | boolean | Optional | |
| payments[].tips | number | Optional | |
| payments[].total | number | Optional | |
| payments[].transNo | string | Optional | |
| payments[].transactionFee | number | Optional | |
| payments[].transactionId | string | Optional | |
| payments[].updated | boolean | Optional | |
| payments[].voidT | boolean | Optional | |
| pickUpDate | int64 | Optional | |
| pointsEarned | number | Optional | |
| preparedBy | string | Optional | |
| preparedByEmployee | object | Employee | Optional |
| preparedByEmployee.address | object | Address | Optional |
| preparedByEmployee.address.address | string | Optional | |
| preparedByEmployee.address.addressLine2 | string | Optional | |
| preparedByEmployee.address.city | string | Optional | |
| preparedByEmployee.address.companyId | string | Optional | |
| preparedByEmployee.address.country | string | Optional | |
| preparedByEmployee.address.created | int64 | Optional | |
| preparedByEmployee.address.deleted | boolean | Optional | |
| preparedByEmployee.address.id | string | Optional | |
| preparedByEmployee.address.latitude | number | Optional | |
| preparedByEmployee.address.longitude | number | Optional | |
| preparedByEmployee.address.modified | int64 | Optional | |
| preparedByEmployee.address.state | string | Optional | |
| preparedByEmployee.address.updated | boolean | Optional | |
| preparedByEmployee.address.zipCode | string | Optional | |
| preparedByEmployee.appAccessList[] | array of string |
Possible values are:
|
Optional |
| preparedByEmployee.assignedInventoryId | string | Optional | |
| preparedByEmployee.assignedTerminalId | string | Optional | |
| preparedByEmployee.canApplyCustomDiscount | boolean | Optional | |
| preparedByEmployee.cashDrawerStatus | string |
Possible values are:
|
Optional |
| preparedByEmployee.companyId | string | Optional | |
| preparedByEmployee.created | int64 | Optional | |
| preparedByEmployee.deleted | boolean | Optional | |
| preparedByEmployee.disabled | boolean | Optional | |
| preparedByEmployee.dlExpirationDate | string | Optional | |
| preparedByEmployee.driver | boolean | Optional | |
| preparedByEmployee.driversLicense | string | Optional | |
| preparedByEmployee.email | string | Optional | |
| preparedByEmployee.employeeOnFleetInfoList[] | array | Optional | |
| preparedByEmployee.employeeOnFleetInfoList[].onFleetTeamList[] | array of string | Optional | |
| preparedByEmployee.employeeOnFleetInfoList[].onFleetWorkerId | string | Optional | |
| preparedByEmployee.employeeOnFleetInfoList[].shopId | string | Optional | |
| preparedByEmployee.externalId | string | Optional | |
| preparedByEmployee.firstName | string | Optional | |
| preparedByEmployee.id | string | Optional | |
| preparedByEmployee.insuranceCompanyName | string | Optional | |
| preparedByEmployee.insuranceExpireDate | int64 | Optional | |
| preparedByEmployee.inventoryName | string | Optional | |
| preparedByEmployee.lastLoggedInShopId | string | Optional | |
| preparedByEmployee.lastLoginTime | int64 | Optional | |
| preparedByEmployee.lastName | string | Optional | |
| preparedByEmployee.modified | int64 | Optional | |
| preparedByEmployee.notes[] | array | Optional | |
| preparedByEmployee.notes[].created | int64 | Optional | |
| preparedByEmployee.notes[].deleted | boolean | Optional | |
| preparedByEmployee.notes[].enableOnFleet | boolean | Optional | |
| preparedByEmployee.notes[].id | string | Optional | |
| preparedByEmployee.notes[].message | string | Optional | |
| preparedByEmployee.notes[].modified | int64 | Optional | |
| preparedByEmployee.notes[].updated | boolean | Optional | |
| preparedByEmployee.notes[].writerId | string | Optional | |
| preparedByEmployee.notes[].writerName | string | Optional | |
| preparedByEmployee.occupationLicenseNumber | string | Optional | |
| preparedByEmployee.organizationIds[] | array of string | Optional | |
| preparedByEmployee.password | string | Optional | |
| preparedByEmployee.phoneNumber | string | Optional | |
| preparedByEmployee.pin | string | Optional | |
| preparedByEmployee.policyNumber | string | Optional | |
| preparedByEmployee.recentLocation | object | TerminalLocation | Optional |
| preparedByEmployee.recentLocation.companyId | string | Optional | |
| preparedByEmployee.recentLocation.created | int64 | Optional | |
| preparedByEmployee.recentLocation.deleted | boolean | Optional | |
| preparedByEmployee.recentLocation.deviceId | string | Optional | |
| preparedByEmployee.recentLocation.dirty | boolean | Optional | |
| preparedByEmployee.recentLocation.employeeId | string | Optional | |
| preparedByEmployee.recentLocation.id | string | Optional | |
| preparedByEmployee.recentLocation.loc[] | array of double | Optional | |
| preparedByEmployee.recentLocation.modified | int64 | Optional | |
| preparedByEmployee.recentLocation.name | string | Optional | |
| preparedByEmployee.recentLocation.shopId | string | Optional | |
| preparedByEmployee.recentLocation.terminalId | string | Optional | |
| preparedByEmployee.recentLocation.timeCardId | string | Optional | |
| preparedByEmployee.recentLocation.updated | boolean | Optional | |
| preparedByEmployee.registrationExpireDate | int64 | Optional | |
| preparedByEmployee.role | object | Role | Optional |
| preparedByEmployee.role.companyId | string | Optional | |
| preparedByEmployee.role.created | int64 | Optional | |
| preparedByEmployee.role.deleted | boolean | Optional | |
| preparedByEmployee.role.id | string | Optional | |
| preparedByEmployee.role.modified | int64 | Optional | |
| preparedByEmployee.role.name | string | Optional | |
| preparedByEmployee.role.permissions[] | array of string |
Possible values are:
|
Optional |
| preparedByEmployee.role.updated | boolean | Optional | |
| preparedByEmployee.roleId | string | Optional | |
| preparedByEmployee.shops[] | array of string | Optional | |
| preparedByEmployee.terminalName | string | Optional | |
| preparedByEmployee.timeCard | object | TimeCard | Optional |
| preparedByEmployee.timeCard.clockInTime | int64 | Optional | |
| preparedByEmployee.timeCard.clockOutTime | int64 | Optional | |
| preparedByEmployee.timeCard.clockin | boolean | Optional | |
| preparedByEmployee.timeCard.companyId | string | Optional | |
| preparedByEmployee.timeCard.created | int64 | Optional | |
| preparedByEmployee.timeCard.deleted | boolean | Optional | |
| preparedByEmployee.timeCard.dirty | boolean | Optional | |
| preparedByEmployee.timeCard.employeeId | string | Optional | |
| preparedByEmployee.timeCard.id | string | Optional | |
| preparedByEmployee.timeCard.modified | int64 | Optional | |
| preparedByEmployee.timeCard.sessions[] | array | Optional | |
| preparedByEmployee.timeCard.sessions[].companyId | string | Optional | |
| preparedByEmployee.timeCard.sessions[].created | int64 | Optional | |
| preparedByEmployee.timeCard.sessions[].deleted | boolean | Optional | |
| preparedByEmployee.timeCard.sessions[].dirty | boolean | Optional | |
| preparedByEmployee.timeCard.sessions[].employeeId | string | Optional | |
| preparedByEmployee.timeCard.sessions[].endTime | int64 | Optional | |
| preparedByEmployee.timeCard.sessions[].id | string | Optional | |
| preparedByEmployee.timeCard.sessions[].modified | int64 | Optional | |
| preparedByEmployee.timeCard.sessions[].shopId | string | Optional | |
| preparedByEmployee.timeCard.sessions[].startTime | int64 | Optional | |
| preparedByEmployee.timeCard.sessions[].terminalId | string | Optional | |
| preparedByEmployee.timeCard.sessions[].timeCardId | string | Optional | |
| preparedByEmployee.timeCard.sessions[].updated | boolean | Optional | |
| preparedByEmployee.timeCard.shopId | string | Optional | |
| preparedByEmployee.timeCard.updated | boolean | Optional | |
| preparedByEmployee.timecardId | string | Optional | |
| preparedByEmployee.tookanInfoList[] | array | Optional | |
| preparedByEmployee.tookanInfoList[].shopId | string | Optional | |
| preparedByEmployee.tookanInfoList[].status | string |
Possible values are:
|
Optional |
| preparedByEmployee.tookanInfoList[].teamId | string | Optional | |
| preparedByEmployee.tookanInfoList[].tookanAgentId | string | Optional | |
| preparedByEmployee.updated | boolean | Optional | |
| preparedByEmployee.vehicleLicensePlate | string | Optional | |
| preparedByEmployee.vehicleMake | string | Optional | |
| preparedByEmployee.vehicleModel | string | Optional | |
| preparedByEmployee.vehiclePin | string | Optional | |
| preparedByEmployee.vinNo | string | Optional | |
| preparedDate | int64 | Optional | |
| preparingFulfillment | boolean | Optional | |
| previousBalance | number | Optional | |
| priority | int64 | Optional | |
| processedTime | int64 | Optional | |
| qbJournalEntryRef | string | Optional | |
| qbRefundReceipt | string | Optional | |
| qbSalesReceiptRef | string | Optional | |
| queueBlazePayId | string | Optional | |
| queueType | string |
Possible values are:
|
Optional |
| refundPaymentOptions[] | array of string |
Possible values are:
|
Optional |
| refundVersion | string |
Possible values are:
|
Optional |
| routing | boolean | Optional | |
| seller | object | Employee | Optional |
| seller.address | object | Address | Optional |
| seller.address.address | string | Optional | |
| seller.address.addressLine2 | string | Optional | |
| seller.address.city | string | Optional | |
| seller.address.companyId | string | Optional | |
| seller.address.country | string | Optional | |
| seller.address.created | int64 | Optional | |
| seller.address.deleted | boolean | Optional | |
| seller.address.id | string | Optional | |
| seller.address.latitude | number | Optional | |
| seller.address.longitude | number | Optional | |
| seller.address.modified | int64 | Optional | |
| seller.address.state | string | Optional | |
| seller.address.updated | boolean | Optional | |
| seller.address.zipCode | string | Optional | |
| seller.appAccessList[] | array of string |
Possible values are:
|
Optional |
| seller.assignedInventoryId | string | Optional | |
| seller.assignedTerminalId | string | Optional | |
| seller.canApplyCustomDiscount | boolean | Optional | |
| seller.cashDrawerStatus | string |
Possible values are:
|
Optional |
| seller.companyId | string | Optional | |
| seller.created | int64 | Optional | |
| seller.deleted | boolean | Optional | |
| seller.disabled | boolean | Optional | |
| seller.dlExpirationDate | string | Optional | |
| seller.driver | boolean | Optional | |
| seller.driversLicense | string | Optional | |
| seller.email | string | Optional | |
| seller.employeeOnFleetInfoList[] | array | Optional | |
| seller.employeeOnFleetInfoList[].onFleetTeamList[] | array of string | Optional | |
| seller.employeeOnFleetInfoList[].onFleetWorkerId | string | Optional | |
| seller.employeeOnFleetInfoList[].shopId | string | Optional | |
| seller.externalId | string | Optional | |
| seller.firstName | string | Optional | |
| seller.id | string | Optional | |
| seller.insuranceCompanyName | string | Optional | |
| seller.insuranceExpireDate | int64 | Optional | |
| seller.inventoryName | string | Optional | |
| seller.lastLoggedInShopId | string | Optional | |
| seller.lastLoginTime | int64 | Optional | |
| seller.lastName | string | Optional | |
| seller.modified | int64 | Optional | |
| seller.notes[] | array | Optional | |
| seller.notes[].created | int64 | Optional | |
| seller.notes[].deleted | boolean | Optional | |
| seller.notes[].enableOnFleet | boolean | Optional | |
| seller.notes[].id | string | Optional | |
| seller.notes[].message | string | Optional | |
| seller.notes[].modified | int64 | Optional | |
| seller.notes[].updated | boolean | Optional | |
| seller.notes[].writerId | string | Optional | |
| seller.notes[].writerName | string | Optional | |
| seller.occupationLicenseNumber | string | Optional | |
| seller.organizationIds[] | array of string | Optional | |
| seller.password | string | Optional | |
| seller.phoneNumber | string | Optional | |
| seller.pin | string | Optional | |
| seller.policyNumber | string | Optional | |
| seller.recentLocation | object | TerminalLocation | Optional |
| seller.recentLocation.companyId | string | Optional | |
| seller.recentLocation.created | int64 | Optional | |
| seller.recentLocation.deleted | boolean | Optional | |
| seller.recentLocation.deviceId | string | Optional | |
| seller.recentLocation.dirty | boolean | Optional | |
| seller.recentLocation.employeeId | string | Optional | |
| seller.recentLocation.id | string | Optional | |
| seller.recentLocation.loc[] | array of double | Optional | |
| seller.recentLocation.modified | int64 | Optional | |
| seller.recentLocation.name | string | Optional | |
| seller.recentLocation.shopId | string | Optional | |
| seller.recentLocation.terminalId | string | Optional | |
| seller.recentLocation.timeCardId | string | Optional | |
| seller.recentLocation.updated | boolean | Optional | |
| seller.registrationExpireDate | int64 | Optional | |
| seller.role | object | Role | Optional |
| seller.role.companyId | string | Optional | |
| seller.role.created | int64 | Optional | |
| seller.role.deleted | boolean | Optional | |
| seller.role.id | string | Optional | |
| seller.role.modified | int64 | Optional | |
| seller.role.name | string | Optional | |
| seller.role.permissions[] | array of string |
Possible values are:
|
Optional |
| seller.role.updated | boolean | Optional | |
| seller.roleId | string | Optional | |
| seller.shops[] | array of string | Optional | |
| seller.terminalName | string | Optional | |
| seller.timeCard | object | TimeCard | Optional |
| seller.timeCard.clockInTime | int64 | Optional | |
| seller.timeCard.clockOutTime | int64 | Optional | |
| seller.timeCard.clockin | boolean | Optional | |
| seller.timeCard.companyId | string | Optional | |
| seller.timeCard.created | int64 | Optional | |
| seller.timeCard.deleted | boolean | Optional | |
| seller.timeCard.dirty | boolean | Optional | |
| seller.timeCard.employeeId | string | Optional | |
| seller.timeCard.id | string | Optional | |
| seller.timeCard.modified | int64 | Optional | |
| seller.timeCard.sessions[] | array | Optional | |
| seller.timeCard.sessions[].companyId | string | Optional | |
| seller.timeCard.sessions[].created | int64 | Optional | |
| seller.timeCard.sessions[].deleted | boolean | Optional | |
| seller.timeCard.sessions[].dirty | boolean | Optional | |
| seller.timeCard.sessions[].employeeId | string | Optional | |
| seller.timeCard.sessions[].endTime | int64 | Optional | |
| seller.timeCard.sessions[].id | string | Optional | |
| seller.timeCard.sessions[].modified | int64 | Optional | |
| seller.timeCard.sessions[].shopId | string | Optional | |
| seller.timeCard.sessions[].startTime | int64 | Optional | |
| seller.timeCard.sessions[].terminalId | string | Optional | |
| seller.timeCard.sessions[].timeCardId | string | Optional | |
| seller.timeCard.sessions[].updated | boolean | Optional | |
| seller.timeCard.shopId | string | Optional | |
| seller.timeCard.updated | boolean | Optional | |
| seller.timecardId | string | Optional | |
| seller.tookanInfoList[] | array | Optional | |
| seller.tookanInfoList[].shopId | string | Optional | |
| seller.tookanInfoList[].status | string |
Possible values are:
|
Optional |
| seller.tookanInfoList[].teamId | string | Optional | |
| seller.tookanInfoList[].tookanAgentId | string | Optional | |
| seller.updated | boolean | Optional | |
| seller.vehicleLicensePlate | string | Optional | |
| seller.vehicleMake | string | Optional | |
| seller.vehicleModel | string | Optional | |
| seller.vehiclePin | string | Optional | |
| seller.vinNo | string | Optional | |
| sellerId | string | Optional | |
| sellerTerminal | object | Terminal | Optional |
| sellerTerminal.active | boolean | Optional | |
| sellerTerminal.appVersion | string | Optional | |
| sellerTerminal.assignedInventoryId | string | Optional | |
| sellerTerminal.checkoutType | string |
Possible values are:
|
Optional |
| sellerTerminal.companyId | string | Optional | |
| sellerTerminal.created | int64 | Optional | |
| sellerTerminal.creditCardReader | object | CreditCardReader | Optional |
| sellerTerminal.creditCardReader.encryptionType | string |
Possible values are:
|
Optional |
| sellerTerminal.creditCardReader.secretKey | string | Optional | |
| sellerTerminal.currentEmployeeId | string | Optional | |
| sellerTerminal.cvAccountId | string | Optional | |
| sellerTerminal.deleted | boolean | Optional | |
| sellerTerminal.deviceDetails[] | array | Optional | |
| sellerTerminal.deviceDetails[].active | boolean | Optional | |
| sellerTerminal.deviceDetails[].appType | string |
Possible values are:
|
Optional |
| sellerTerminal.deviceDetails[].deviceId | string | Optional | |
| sellerTerminal.deviceDetails[].deviceModel | string | Optional | |
| sellerTerminal.deviceDetails[].deviceName | string | Optional | |
| sellerTerminal.deviceDetails[].deviceToken | string | Optional | |
| sellerTerminal.deviceDetails[].deviceType | string |
Possible values are:
|
Optional |
| sellerTerminal.deviceDetails[].deviceVersion | string | Optional | |
| sellerTerminal.deviceDetails[].sdkVersion | string | Optional | |
| sellerTerminal.deviceDetails[].version | string | Optional | |
| sellerTerminal.deviceId | string | Optional | |
| sellerTerminal.deviceModel | string | Optional | |
| sellerTerminal.deviceName | string | Optional | |
| sellerTerminal.deviceToken | string | Optional | |
| sellerTerminal.deviceType | string | Optional | |
| sellerTerminal.deviceVersion | string | Optional | |
| sellerTerminal.dirty | boolean | Optional | |
| sellerTerminal.id | string | Optional | |
| sellerTerminal.modified | int64 | Optional | |
| sellerTerminal.name | string | Optional | |
| sellerTerminal.onPremEnabled | boolean | Optional | |
| sellerTerminal.posTerminal | string | Optional | |
| sellerTerminal.regionId | string | Optional | |
| sellerTerminal.shopId | string | Optional | |
| sellerTerminal.terminalLocations[] | array | Optional | |
| sellerTerminal.terminalLocations[].companyId | string | Optional | |
| sellerTerminal.terminalLocations[].created | int64 | Optional | |
| sellerTerminal.terminalLocations[].deleted | boolean | Optional | |
| sellerTerminal.terminalLocations[].deviceId | string | Optional | |
| sellerTerminal.terminalLocations[].dirty | boolean | Optional | |
| sellerTerminal.terminalLocations[].employeeId | string | Optional | |
| sellerTerminal.terminalLocations[].id | string | Optional | |
| sellerTerminal.terminalLocations[].loc[] | array of double | Optional | |
| sellerTerminal.terminalLocations[].modified | int64 | Optional | |
| sellerTerminal.terminalLocations[].name | string | Optional | |
| sellerTerminal.terminalLocations[].shopId | string | Optional | |
| sellerTerminal.terminalLocations[].terminalId | string | Optional | |
| sellerTerminal.terminalLocations[].timeCardId | string | Optional | |
| sellerTerminal.terminalLocations[].updated | boolean | Optional | |
| sellerTerminal.terminalType | string |
Possible values are:
|
Optional |
| sellerTerminal.updated | boolean | Optional | |
| sellerTerminalId | string | Optional | |
| sessionId | string | Optional | |
| shopId | string | Optional | |
| shortId | string | Optional | |
| source | string | Optional | |
| startRouteDate | int64 | Optional | |
| startRouteLocation[] | array of double | Optional | |
| startTime | int64 | Optional | |
| state | int32 | Optional | |
| status | string |
Possible values are:
|
Optional |
| terminal | object | Terminal | Optional |
| terminal.active | boolean | Optional | |
| terminal.appVersion | string | Optional | |
| terminal.assignedInventoryId | string | Optional | |
| terminal.checkoutType | string |
Possible values are:
|
Optional |
| terminal.companyId | string | Optional | |
| terminal.created | int64 | Optional | |
| terminal.creditCardReader | object | CreditCardReader | Optional |
| terminal.creditCardReader.encryptionType | string |
Possible values are:
|
Optional |
| terminal.creditCardReader.secretKey | string | Optional | |
| terminal.currentEmployeeId | string | Optional | |
| terminal.cvAccountId | string | Optional | |
| terminal.deleted | boolean | Optional | |
| terminal.deviceDetails[] | array | Optional | |
| terminal.deviceDetails[].active | boolean | Optional | |
| terminal.deviceDetails[].appType | string |
Possible values are:
|
Optional |
| terminal.deviceDetails[].deviceId | string | Optional | |
| terminal.deviceDetails[].deviceModel | string | Optional | |
| terminal.deviceDetails[].deviceName | string | Optional | |
| terminal.deviceDetails[].deviceToken | string | Optional | |
| terminal.deviceDetails[].deviceType | string |
Possible values are:
|
Optional |
| terminal.deviceDetails[].deviceVersion | string | Optional | |
| terminal.deviceDetails[].sdkVersion | string | Optional | |
| terminal.deviceDetails[].version | string | Optional | |
| terminal.deviceId | string | Optional | |
| terminal.deviceModel | string | Optional | |
| terminal.deviceName | string | Optional | |
| terminal.deviceToken | string | Optional | |
| terminal.deviceType | string | Optional | |
| terminal.deviceVersion | string | Optional | |
| terminal.dirty | boolean | Optional | |
| terminal.id | string | Optional | |
| terminal.modified | int64 | Optional | |
| terminal.name | string | Optional | |
| terminal.onPremEnabled | boolean | Optional | |
| terminal.posTerminal | string | Optional | |
| terminal.regionId | string | Optional | |
| terminal.shopId | string | Optional | |
| terminal.terminalLocations[] | array | Optional | |
| terminal.terminalLocations[].companyId | string | Optional | |
| terminal.terminalLocations[].created | int64 | Optional | |
| terminal.terminalLocations[].deleted | boolean | Optional | |
| terminal.terminalLocations[].deviceId | string | Optional | |
| terminal.terminalLocations[].dirty | boolean | Optional | |
| terminal.terminalLocations[].employeeId | string | Optional | |
| terminal.terminalLocations[].id | string | Optional | |
| terminal.terminalLocations[].loc[] | array of double | Optional | |
| terminal.terminalLocations[].modified | int64 | Optional | |
| terminal.terminalLocations[].name | string | Optional | |
| terminal.terminalLocations[].shopId | string | Optional | |
| terminal.terminalLocations[].terminalId | string | Optional | |
| terminal.terminalLocations[].timeCardId | string | Optional | |
| terminal.terminalLocations[].updated | boolean | Optional | |
| terminal.terminalType | string |
Possible values are:
|
Optional |
| terminal.updated | boolean | Optional | |
| terminalId | string | Optional | |
| timeZone | string | Optional | |
| tookanTaskId | string | Optional | |
| traceMessage | string | Optional | |
| traceSubmitStatus | string |
Possible values are:
|
Optional |
| traceSubmitTime | int64 | Optional | |
| trackingStatus | string |
Possible values are:
|
Optional |
| transNo | string | Optional | |
| transType | string |
Possible values are:
|
Optional |
| transactionRefundStatus | string |
Possible values are:
|
Optional |
| transferRequest | object | BulkInventoryTransferRequest | Optional |
| transferRequest.fromShopId | string | Optional | |
| transferRequest.toShopId | string | Optional | |
| transferRequest.transfers[] | array | Optional | |
| transferRequest.transfers[].fromBatchId | string | Optional | |
| transferRequest.transfers[].fromInventoryId | string | Optional | |
| transferRequest.transfers[].prepackageItemId | string | Optional | |
| transferRequest.transfers[].productId | string | Optional | |
| transferRequest.transfers[].toBatchId | string | Optional | |
| transferRequest.transfers[].toInventoryId | string | Optional | |
| transferRequest.transfers[].transferAmount | number | Optional | |
| transferShopId | string | Optional | |
| updated | boolean | Optional | |
| voidDate | int64 | Optional | |
| voidedByEmployeeId | string | Optional | |
| waivedDate | int64 | Optional | |
| waivedStatus | boolean | Optional |
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK successful operation |
Transaction |