Finalize All Items in Cart
Request
POST http:///api/v1/partner/store/cart/items/finalize
Query parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| cuid | string |
Request body
The request body takes a complete ConsumerCart resource, containing the following writable properties:
{
"accepted": "boolean",
"acceptedTime": "int64",
"additionalNotes": "string",
"assignedEmployeeId": "string",
"assignedNearbyDriverId": "string",
"canceledTime": "int64",
"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"
},
"cartStatus": "string",
"companyId": "string",
"completeAfter": "int64",
"completed": "boolean",
"completedTime": "int64",
"consumerId": "string",
"consumerUser": {
"accepted": "boolean",
"acceptedDate": "int64",
"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"
},
"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"
}
],
"companyId": "string",
"consumerType": "string",
"cpn": "string",
"created": "int64",
"deleted": "boolean",
"dlExpiration": "int64",
"dlNo": "string",
"dlPhoto": {
"active": "boolean",
"assetType": "string",
"created": "int64",
"deleted": "boolean",
"documentId": "string",
"id": "string",
"key": "string",
"modified": "int64",
"name": "string",
"type": "string",
"updated": "boolean"
},
"dlState": "string",
"dob": "int64",
"doctorFirstName": "string",
"doctorLastName": "string",
"doctorLicense": "string",
"email": "string",
"emailOptIn": "boolean",
"firstName": "string",
"id": "string",
"importId": "string",
"lastName": "string",
"lastSyncDate": "int64",
"marketingSource": "string",
"medical": "boolean",
"memberId": "string",
"memberIds": [
"string"
],
"memberStatuses": [
{
"accepted": "boolean",
"acceptedDate": "int64",
"companyId": "string",
"consumerId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"id": "string",
"lastSyncDate": "int64",
"memberId": "string",
"modified": "int64",
"reason": "string",
"shopId": "string",
"updated": "boolean"
}
],
"middleName": "string",
"modified": "int64",
"notificationType": "string",
"password": "string",
"primaryPhone": "string",
"reason": "string",
"recExpiration": "int64",
"recIssueDate": "int64",
"recNo": "string",
"recPhoto": {
"active": "boolean",
"assetType": "string",
"created": "int64",
"deleted": "boolean",
"documentId": "string",
"id": "string",
"key": "string",
"modified": "int64",
"name": "string",
"type": "string",
"updated": "boolean"
},
"rejectedDate": "int64",
"searchText": "string",
"sex": "string",
"signedContracts": [
{
"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"
}
}
],
"source": "string",
"sourceCompanyId": "string",
"textOptIn": "boolean",
"updated": "boolean",
"verificationPhone": "string",
"verificationWebsite": "string",
"verified": "boolean",
"verifyMethod": "string"
},
"created": "int64",
"declinedTime": "int64",
"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",
"dirty": "boolean",
"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"
},
"employeeName": "string",
"errorMsg": "string",
"eta": "int32",
"externalId": "string",
"id": "string",
"inventoryId": "string",
"memberGroup": {
"discount": "number",
"discountType": "string",
"name": "string"
},
"memberId": "string",
"memo": "string",
"modified": "int64",
"onTheWay": "boolean",
"onTheWayTime": "int64",
"orderNo": "string",
"orderPlacedTime": "int64",
"orderTags": [
"string"
],
"packaged": "boolean",
"packagedTime": "int64",
"pickUpDate": "int64",
"pickupType": "string",
"prepaid": "boolean",
"publicKey": "string",
"reason": "string",
"rewardErrorMap": {
"<key>": "string"
},
"rewardName": "string",
"sessionId": "string",
"shopId": "string",
"slugRewardErrorMap": {
"<key>": "string"
},
"source": "string",
"terminalId": "string",
"trackingStatus": "string",
"transNo": "string",
"transactionId": "string",
"transactionSource": "string",
"updated": "boolean"
}Properties
| Name | Type | Description | Additional |
|---|---|---|---|
| accepted | boolean | Optional | |
| acceptedTime | int64 | Optional | |
| additionalNotes | string | Optional | |
| assignedEmployeeId | string | Optional | |
| assignedNearbyDriverId | string | Optional | |
| canceledTime | int64 | 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 | |
| cartStatus | string |
Possible values are:
|
Optional |
| companyId | string | Optional | |
| completeAfter | int64 | Optional | |
| completed | boolean | Optional | |
| completedTime | int64 | Optional | |
| consumerId | string | Optional | |
| consumerUser | object | ConsumerUser | Optional |
| consumerUser.accepted | boolean | Optional | |
| consumerUser.acceptedDate | int64 | Optional | |
| consumerUser.active | boolean | Optional | |
| consumerUser.address | object | Address | Optional |
| consumerUser.address.address | string | Optional | |
| consumerUser.address.addressLine2 | string | Optional | |
| consumerUser.address.city | string | Optional | |
| consumerUser.address.companyId | string | Optional | |
| consumerUser.address.country | string | Optional | |
| consumerUser.address.created | int64 | Optional | |
| consumerUser.address.deleted | boolean | Optional | |
| consumerUser.address.id | string | Optional | |
| consumerUser.address.latitude | number | Optional | |
| consumerUser.address.longitude | number | Optional | |
| consumerUser.address.modified | int64 | Optional | |
| consumerUser.address.state | string | Optional | |
| consumerUser.address.updated | boolean | Optional | |
| consumerUser.address.zipCode | string | Optional | |
| consumerUser.addresses[] | array | Optional | |
| consumerUser.addresses[].address | string | Optional | |
| consumerUser.addresses[].addressLine2 | string | Optional | |
| consumerUser.addresses[].city | string | Optional | |
| consumerUser.addresses[].companyId | string | Optional | |
| consumerUser.addresses[].country | string | Optional | |
| consumerUser.addresses[].created | int64 | Optional | |
| consumerUser.addresses[].deleted | boolean | Optional | |
| consumerUser.addresses[].id | string | Optional | |
| consumerUser.addresses[].latitude | number | Optional | |
| consumerUser.addresses[].longitude | number | Optional | |
| consumerUser.addresses[].modified | int64 | Optional | |
| consumerUser.addresses[].state | string | Optional | |
| consumerUser.addresses[].updated | boolean | Optional | |
| consumerUser.addresses[].zipCode | string | Optional | |
| consumerUser.companyId | string | Optional | |
| consumerUser.consumerType | string |
Possible values are:
|
Optional |
| consumerUser.cpn | string | Optional | |
| consumerUser.created | int64 | Optional | |
| consumerUser.deleted | boolean | Optional | |
| consumerUser.dlExpiration | int64 | Optional | |
| consumerUser.dlNo | string | Optional | |
| consumerUser.dlPhoto | object | ConsumerAsset | Optional |
| consumerUser.dlPhoto.active | boolean | Optional | |
| consumerUser.dlPhoto.assetType | string |
Possible values are:
|
Optional |
| consumerUser.dlPhoto.created | int64 | Optional | |
| consumerUser.dlPhoto.deleted | boolean | Optional | |
| consumerUser.dlPhoto.documentId | string | Optional | |
| consumerUser.dlPhoto.id | string | Optional | |
| consumerUser.dlPhoto.key | string | Optional | |
| consumerUser.dlPhoto.modified | int64 | Optional | |
| consumerUser.dlPhoto.name | string | Optional | |
| consumerUser.dlPhoto.type | string |
Possible values are:
|
Optional |
| consumerUser.dlPhoto.updated | boolean | Optional | |
| consumerUser.dlState | string | Optional | |
| consumerUser.dob | int64 | Optional | |
| consumerUser.doctorFirstName | string | Optional | |
| consumerUser.doctorLastName | string | Optional | |
| consumerUser.doctorLicense | string | Optional | |
| consumerUser.email | string | Optional | |
| consumerUser.emailOptIn | boolean | Optional | |
| consumerUser.firstName | string | Optional | |
| consumerUser.id | string | Optional | |
| consumerUser.importId | string | Optional | |
| consumerUser.lastName | string | Optional | |
| consumerUser.lastSyncDate | int64 | Optional | |
| consumerUser.marketingSource | string | Optional | |
| consumerUser.medical | boolean | Optional | |
| consumerUser.memberId | string | Optional | |
| consumerUser.memberIds[] | array of string | Optional | |
| consumerUser.memberStatuses[] | array | Optional | |
| consumerUser.memberStatuses[].accepted | boolean | Optional | |
| consumerUser.memberStatuses[].acceptedDate | int64 | Optional | |
| consumerUser.memberStatuses[].companyId | string | Optional | |
| consumerUser.memberStatuses[].consumerId | string | Optional | |
| consumerUser.memberStatuses[].created | int64 | Optional | |
| consumerUser.memberStatuses[].deleted | boolean | Optional | |
| consumerUser.memberStatuses[].dirty | boolean | Optional | |
| consumerUser.memberStatuses[].id | string | Optional | |
| consumerUser.memberStatuses[].lastSyncDate | int64 | Optional | |
| consumerUser.memberStatuses[].memberId | string | Optional | |
| consumerUser.memberStatuses[].modified | int64 | Optional | |
| consumerUser.memberStatuses[].reason | string | Optional | |
| consumerUser.memberStatuses[].shopId | string | Optional | |
| consumerUser.memberStatuses[].updated | boolean | Optional | |
| consumerUser.middleName | string | Optional | |
| consumerUser.modified | int64 | Optional | |
| consumerUser.notificationType | string |
Possible values are:
|
Optional |
| consumerUser.password | string | Optional | |
| consumerUser.primaryPhone | string | Optional | |
| consumerUser.reason | string | Optional | |
| consumerUser.recExpiration | int64 | Optional | |
| consumerUser.recIssueDate | int64 | Optional | |
| consumerUser.recNo | string | Optional | |
| consumerUser.recPhoto | object | ConsumerAsset | Optional |
| consumerUser.recPhoto.active | boolean | Optional | |
| consumerUser.recPhoto.assetType | string |
Possible values are:
|
Optional |
| consumerUser.recPhoto.created | int64 | Optional | |
| consumerUser.recPhoto.deleted | boolean | Optional | |
| consumerUser.recPhoto.documentId | string | Optional | |
| consumerUser.recPhoto.id | string | Optional | |
| consumerUser.recPhoto.key | string | Optional | |
| consumerUser.recPhoto.modified | int64 | Optional | |
| consumerUser.recPhoto.name | string | Optional | |
| consumerUser.recPhoto.type | string |
Possible values are:
|
Optional |
| consumerUser.recPhoto.updated | boolean | Optional | |
| consumerUser.rejectedDate | int64 | Optional | |
| consumerUser.searchText | string | Optional | |
| consumerUser.sex | string |
Possible values are:
|
Optional |
| consumerUser.signedContracts[] | array | Optional | |
| consumerUser.signedContracts[].companyId | string | Optional | |
| consumerUser.signedContracts[].consumerId | string | Optional | |
| consumerUser.signedContracts[].contractId | string | Optional | |
| consumerUser.signedContracts[].created | int64 | Optional | |
| consumerUser.signedContracts[].deleted | boolean | Optional | |
| consumerUser.signedContracts[].dirty | boolean | Optional | |
| consumerUser.signedContracts[].employeeName | string | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto | object | CompanyAsset | Optional |
| consumerUser.signedContracts[].employeeSignaturePhoto.active | boolean | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.assetType | string |
Possible values are:
|
Optional |
| consumerUser.signedContracts[].employeeSignaturePhoto.companyId | string | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.created | int64 | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.deleted | boolean | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.id | string | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.key | string | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.largeURL | string | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.largeX2URL | string | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.mediumURL | string | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.modified | int64 | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.name | string | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.origURL | string | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.priority | int32 | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.publicURL | string | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.secured | boolean | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.thumbURL | string | Optional | |
| consumerUser.signedContracts[].employeeSignaturePhoto.type | string |
Possible values are:
|
Optional |
| consumerUser.signedContracts[].employeeSignaturePhoto.updated | boolean | Optional | |
| consumerUser.signedContracts[].id | string | Optional | |
| consumerUser.signedContracts[].memberName | string | Optional | |
| consumerUser.signedContracts[].membershipId | string | Optional | |
| consumerUser.signedContracts[].modified | int64 | Optional | |
| consumerUser.signedContracts[].shopId | string | Optional | |
| consumerUser.signedContracts[].signaturePhoto | object | CompanyAsset | Optional |
| consumerUser.signedContracts[].signaturePhoto.active | boolean | Optional | |
| consumerUser.signedContracts[].signaturePhoto.assetType | string |
Possible values are:
|
Optional |
| consumerUser.signedContracts[].signaturePhoto.companyId | string | Optional | |
| consumerUser.signedContracts[].signaturePhoto.created | int64 | Optional | |
| consumerUser.signedContracts[].signaturePhoto.deleted | boolean | Optional | |
| consumerUser.signedContracts[].signaturePhoto.id | string | Optional | |
| consumerUser.signedContracts[].signaturePhoto.key | string | Optional | |
| consumerUser.signedContracts[].signaturePhoto.largeURL | string | Optional | |
| consumerUser.signedContracts[].signaturePhoto.largeX2URL | string | Optional | |
| consumerUser.signedContracts[].signaturePhoto.mediumURL | string | Optional | |
| consumerUser.signedContracts[].signaturePhoto.modified | int64 | Optional | |
| consumerUser.signedContracts[].signaturePhoto.name | string | Optional | |
| consumerUser.signedContracts[].signaturePhoto.origURL | string | Optional | |
| consumerUser.signedContracts[].signaturePhoto.priority | int32 | Optional | |
| consumerUser.signedContracts[].signaturePhoto.publicURL | string | Optional | |
| consumerUser.signedContracts[].signaturePhoto.secured | boolean | Optional | |
| consumerUser.signedContracts[].signaturePhoto.thumbURL | string | Optional | |
| consumerUser.signedContracts[].signaturePhoto.type | string |
Possible values are:
|
Optional |
| consumerUser.signedContracts[].signaturePhoto.updated | boolean | Optional | |
| consumerUser.signedContracts[].signedDate | int64 | Optional | |
| consumerUser.signedContracts[].signedDigitally | boolean | Optional | |
| consumerUser.signedContracts[].updated | boolean | Optional | |
| consumerUser.signedContracts[].witnessName | string | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto | object | CompanyAsset | Optional |
| consumerUser.signedContracts[].witnessSignaturePhoto.active | boolean | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.assetType | string |
Possible values are:
|
Optional |
| consumerUser.signedContracts[].witnessSignaturePhoto.companyId | string | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.created | int64 | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.deleted | boolean | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.id | string | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.key | string | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.largeURL | string | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.largeX2URL | string | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.mediumURL | string | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.modified | int64 | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.name | string | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.origURL | string | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.priority | int32 | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.publicURL | string | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.secured | boolean | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.thumbURL | string | Optional | |
| consumerUser.signedContracts[].witnessSignaturePhoto.type | string |
Possible values are:
|
Optional |
| consumerUser.signedContracts[].witnessSignaturePhoto.updated | boolean | Optional | |
| consumerUser.source | string |
Possible values are:
|
Optional |
| consumerUser.sourceCompanyId | string | Optional | |
| consumerUser.textOptIn | boolean | Optional | |
| consumerUser.updated | boolean | Optional | |
| consumerUser.verificationPhone | string | Optional | |
| consumerUser.verificationWebsite | string | Optional | |
| consumerUser.verified | boolean | Optional | |
| consumerUser.verifyMethod | string |
Possible values are:
|
Optional |
| created | int64 | Optional | |
| declinedTime | int64 | 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 | |
| dirty | boolean | 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 | |
| employeeName | string | Optional | |
| errorMsg | string | Optional | |
| eta | int32 | Optional | |
| externalId | string | Optional | |
| id | string | Optional | |
| inventoryId | string | Optional | |
| memberGroup | object | WooMemberGroupResult | Optional |
| memberGroup.discount | number | Optional | |
| memberGroup.discountType | string |
Possible values are:
|
Optional |
| memberGroup.name | string | Optional | |
| memberId | string | Optional | |
| memo | string | Optional | |
| modified | int64 | Optional | |
| onTheWay | boolean | Optional | |
| onTheWayTime | int64 | Optional | |
| orderNo | string | Optional | |
| orderPlacedTime | int64 | Optional | |
| orderTags[] | array of string | Optional | |
| packaged | boolean | Optional | |
| packagedTime | int64 | Optional | |
| pickUpDate | int64 | Optional | |
| pickupType | string |
Possible values are:
|
Optional |
| prepaid | boolean | Optional | |
| publicKey | string | Optional | |
| reason | string | Optional | |
| rewardErrorMap | object | Optional | |
| rewardErrorMap.<key> | map of string | Optional | |
| rewardName | string | Optional | |
| sessionId | string | Optional | |
| shopId | string | Optional | |
| slugRewardErrorMap | object | Optional | |
| slugRewardErrorMap.<key> | map of string | Optional | |
| source | string | Optional | |
| terminalId | string | Optional | |
| trackingStatus | string |
Possible values are:
|
Optional |
| transNo | string | Optional | |
| transactionId | string | Optional | |
| transactionSource | string |
Possible values are:
|
Optional |
| updated | boolean | Optional |
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK successful operation |
ConsumerCart |