Methods

  • get - Get Store Info

Resource

{
    "companyLogoURL": "string",
    "contract": {
        "active": "boolean",
        "companyId": "string",
        "contentType": "string",
        "created": "int64",
        "deleted": "boolean",
        "dirty": "boolean",
        "enableEmployeeSignature": "boolean",
        "enableWitnessSignature": "boolean",
        "id": "string",
        "modified": "int64",
        "name": "string",
        "pdfFile": {
            "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"
        },
        "required": "boolean",
        "shopId": "string",
        "text": "string",
        "updated": "boolean",
        "version": "int32"
    },
    "shop": {
        "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"
    },
    "toleranceMap": {
        "<key>": {
            "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"
        }
    }
}

Properties

Name Type Description Additional
companyLogoURL string Optional
contract object Contract Optional
contract.active boolean Optional
contract.companyId string Optional
contract.contentType string

Possible values are:

  • TEXT
  • PDF
Optional
contract.created int64 Optional
contract.deleted boolean Optional
contract.dirty boolean Optional
contract.enableEmployeeSignature boolean Optional
contract.enableWitnessSignature boolean Optional
contract.id string Optional
contract.modified int64 Optional
contract.name string Optional
contract.pdfFile object CompanyAsset Optional
contract.pdfFile.active boolean Optional
contract.pdfFile.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
contract.pdfFile.companyId string Optional
contract.pdfFile.created int64 Optional
contract.pdfFile.deleted boolean Optional
contract.pdfFile.id string Optional
contract.pdfFile.key string Optional
contract.pdfFile.largeURL string Optional
contract.pdfFile.largeX2URL string Optional
contract.pdfFile.mediumURL string Optional
contract.pdfFile.modified int64 Optional
contract.pdfFile.name string Optional
contract.pdfFile.origURL string Optional
contract.pdfFile.priority int32 Optional
contract.pdfFile.publicURL string Optional
contract.pdfFile.secured boolean Optional
contract.pdfFile.thumbURL string Optional
contract.pdfFile.type string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
contract.pdfFile.updated boolean Optional
contract.required boolean Optional
contract.shopId string Optional
contract.text string Optional
contract.updated boolean Optional
contract.version int32 Optional
shop object Shop Optional
shop.active boolean Optional
shop.address object Address Optional
shop.address.address string Optional
shop.address.addressLine2 string Optional
shop.address.city string Optional
shop.address.companyId string Optional
shop.address.country string Optional
shop.address.created int64 Optional
shop.address.deleted boolean Optional
shop.address.id string Optional
shop.address.latitude number Optional
shop.address.longitude number Optional
shop.address.modified int64 Optional
shop.address.state string Optional
shop.address.updated boolean Optional
shop.address.zipCode string Optional
shop.ageLimit int32 Optional
shop.alExciseOnZeroPrice boolean Optional
shop.allowAnonymousOrders boolean Optional
shop.appTarget string

Possible values are:

  • AuthenticationApp
  • Retail
  • Distribution
  • Grow
  • Dispatch
Optional
shop.appendBrandNameWM boolean Optional
shop.assets[] array Optional
shop.assets[].active boolean Optional
shop.assets[].assetType string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
shop.assets[].companyId string Optional
shop.assets[].created int64 Optional
shop.assets[].deleted boolean Optional
shop.assets[].id string Optional
shop.assets[].key string Optional
shop.assets[].largeURL string Optional
shop.assets[].largeX2URL string Optional
shop.assets[].mediumURL string Optional
shop.assets[].modified int64 Optional
shop.assets[].name string Optional
shop.assets[].origURL string Optional
shop.assets[].priority int32 Optional
shop.assets[].publicURL string Optional
shop.assets[].secured boolean Optional
shop.assets[].thumbURL string Optional
shop.assets[].type string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
shop.assets[].updated boolean Optional
shop.autoCashDrawer boolean Optional
shop.bccEmailAddress string Optional
shop.blazeConnections[] array of string Optional
shop.blazePayFeeList[] array Optional
shop.blazePayFeeList[].companyId string Optional
shop.blazePayFeeList[].created int64 Optional
shop.blazePayFeeList[].deleted boolean Optional
shop.blazePayFeeList[].dirty boolean Optional
shop.blazePayFeeList[].enabled boolean Optional
shop.blazePayFeeList[].fee number Optional
shop.blazePayFeeList[].feeType string

Possible values are:

  • CreditCard
  • CashlessAtm
  • BLAZEPAY
Optional
shop.blazePayFeeList[].id string Optional
shop.blazePayFeeList[].modified int64 Optional
shop.blazePayFeeList[].shopId string Optional
shop.blazePayFeeList[].subTotalThreshold number Optional
shop.blazePayFeeList[].type string

Possible values are:

  • Cash
  • Percentage
  • FinalPrice
Optional
shop.blazePayFeeList[].updated boolean Optional
shop.cartMinimums object CartMinimums Optional
shop.cartMinimums.cartMinimumDetails[] array Optional
shop.cartMinimums.cartMinimumDetails[].distance number Optional
shop.cartMinimums.cartMinimumDetails[].enabled boolean Optional
shop.cartMinimums.cartMinimumDetails[].minimum number Optional
shop.cartMinimums.cartMinimumDetails[].zipCodes[] array of string Optional
shop.cartMinimums.companyId string Optional
shop.cartMinimums.created int64 Optional
shop.cartMinimums.deleted boolean Optional
shop.cartMinimums.id string Optional
shop.cartMinimums.minimumsType string

Possible values are:

  • SIMPLE
  • DISTANCE
  • ZIP_CODE
Optional
shop.cartMinimums.modified int64 Optional
shop.cartMinimums.updated boolean Optional
shop.checkDuplicateDl boolean Optional
shop.checkoutType string

Possible values are:

  • Direct
  • Fulfillment
  • FulfillmentThreeStep
Optional
shop.companyId string Optional
shop.created int64 Optional
shop.creditCardFeeList[] array Optional
shop.creditCardFeeList[].companyId string Optional
shop.creditCardFeeList[].created int64 Optional
shop.creditCardFeeList[].deleted boolean Optional
shop.creditCardFeeList[].dirty boolean Optional
shop.creditCardFeeList[].enabled boolean Optional
shop.creditCardFeeList[].fee number Optional
shop.creditCardFeeList[].feeType string

Possible values are:

  • CreditCard
  • CashlessAtm
  • BLAZEPAY
Optional
shop.creditCardFeeList[].id string Optional
shop.creditCardFeeList[].modified int64 Optional
shop.creditCardFeeList[].shopId string Optional
shop.creditCardFeeList[].subTotalThreshold number Optional
shop.creditCardFeeList[].type string

Possible values are:

  • Cash
  • Percentage
  • FinalPrice
Optional
shop.creditCardFeeList[].updated boolean Optional
shop.creditFefundType string

Possible values are:

  • NONE
  • FULL
  • PARTIAL
Optional
shop.defaultCountry string Optional
shop.defaultHandOverMin int32 Optional
shop.defaultPinTimeout int32 Optional
shop.deleted boolean Optional
shop.deliveryFee number Optional
shop.deliveryFees[] array Optional
shop.deliveryFees[].companyId string Optional
shop.deliveryFees[].created int64 Optional
shop.deliveryFees[].deleted boolean Optional
shop.deliveryFees[].distance number Optional
shop.deliveryFees[].enabled boolean Optional
shop.deliveryFees[].fee number Optional
shop.deliveryFees[].feeType string

Possible values are:

  • CART_SUB_TOTAL
  • DISTANCE
  • ZIP_Code
Optional
shop.deliveryFees[].id string Optional
shop.deliveryFees[].modified int64 Optional
shop.deliveryFees[].subTotalThreshold number Optional
shop.deliveryFees[].type string

Possible values are:

  • Cash
  • Percentage
  • FinalPrice
Optional
shop.deliveryFees[].updated boolean Optional
shop.deliveryFees[].zipCodes[] array of string Optional
shop.deliveryMaxOrders int32 Optional
shop.deliveryRefundType string

Possible values are:

  • NONE
  • FULL
  • PARTIAL
Optional
shop.disableMedicalProductsForAdultUse boolean Optional
shop.emailAdress string Optional
shop.emailAttachment object CompanyAsset Optional
shop.emailAttachment.active boolean Optional
shop.emailAttachment.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
shop.emailAttachment.companyId string Optional
shop.emailAttachment.created int64 Optional
shop.emailAttachment.deleted boolean Optional
shop.emailAttachment.id string Optional
shop.emailAttachment.key string Optional
shop.emailAttachment.largeURL string Optional
shop.emailAttachment.largeX2URL string Optional
shop.emailAttachment.mediumURL string Optional
shop.emailAttachment.modified int64 Optional
shop.emailAttachment.name string Optional
shop.emailAttachment.origURL string Optional
shop.emailAttachment.priority int32 Optional
shop.emailAttachment.publicURL string Optional
shop.emailAttachment.secured boolean Optional
shop.emailAttachment.thumbURL string Optional
shop.emailAttachment.type string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
shop.emailAttachment.updated boolean Optional
shop.emailList[] array of string Optional
shop.emailMessage string Optional
shop.enableAfterTaxDiscountNotes boolean Optional
shop.enableAgeLimit boolean Optional
shop.enableAutoPrintAtFulfillment boolean Optional
shop.enableBCCReceipt boolean Optional
shop.enableCannabisLimit boolean Optional
shop.enableCartDiscountNotes boolean Optional
shop.enableCashInOut boolean Optional
shop.enableCommittedValidation boolean Optional
shop.enableComplianceTesting boolean Optional
shop.enableCustomerIdentification boolean Optional
shop.enableDOBNameUniqueness boolean Optional
shop.enableDailySummaryEmail boolean Optional
shop.enableDeferTransactions boolean Optional
shop.enableDeliveryFee boolean Optional
shop.enableDeliverySignature boolean Optional
shop.enableDiscountNotes boolean Optional
shop.enableExciseTax boolean Optional
shop.enableGPSTracking boolean Optional
shop.enableHarvestTax boolean Optional
shop.enableIncomingOrders boolean Optional
shop.enableLowInventoryEmail boolean Optional
shop.enableMedicinalAge boolean Optional
shop.enableOnFleet boolean Optional
shop.enablePinForCashDrawer boolean Optional
shop.enableRefundNote boolean Optional
shop.enableSaleLogout boolean Optional
shop.enableSpringBig boolean Optional
shop.enableTip boolean Optional
shop.enableTipsBlazePay boolean Optional
shop.enableTookan boolean Optional
shop.enableUnAssignedOnfleetOrder boolean Optional
shop.enableWaive boolean Optional
shop.enableWooCommerce boolean Optional
shop.enforceCashDrawers boolean Optional
shop.exciseTaxType string

Possible values are:

  • PER_ITEM
  • TOTAL_AMOUNT
Optional
shop.flowerType[] array of string Optional
shop.getdraftOrderTimeout int32 Optional
shop.hubId string Optional
shop.hubName string Optional
shop.id string Optional
shop.invoiceNote string Optional
shop.invoiceTermCondition string Optional
shop.latitude double Optional
shop.legalLanguage string Optional
shop.license string Optional
shop.logo object CompanyAsset Optional
shop.logo.active boolean Optional
shop.logo.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
shop.logo.companyId string Optional
shop.logo.created int64 Optional
shop.logo.deleted boolean Optional
shop.logo.id string Optional
shop.logo.key string Optional
shop.logo.largeURL string Optional
shop.logo.largeX2URL string Optional
shop.logo.mediumURL string Optional
shop.logo.modified int64 Optional
shop.logo.name string Optional
shop.logo.origURL string Optional
shop.logo.priority int32 Optional
shop.logo.publicURL string Optional
shop.logo.secured boolean Optional
shop.logo.thumbURL string Optional
shop.logo.type string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
shop.logo.updated boolean Optional
shop.longitude double Optional
shop.marketingSources[] array of string Optional
shop.medicinalAge int32 Optional
shop.membersCountSyncDate int64 Optional
shop.membersTag[] array of string Optional
shop.modified int64 Optional
shop.nalExciseFromRetailCost boolean Optional
shop.name string Optional
shop.nextSnapshotTime int64 Optional
shop.nonCannabisTaxes object NonCannabisTaxInfo Optional
shop.nonCannabisTaxes.alExciseOnZeroPrice boolean Optional
shop.nonCannabisTaxes.enableNonCannabisTax boolean Optional
shop.nonCannabisTaxes.nalExciseFromRetailCost boolean Optional
shop.nonCannabisTaxes.nonCannabisType string

Possible values are:

  • PER_ITEM
  • TOTAL_AMOUNT
Optional
shop.nonCannabisTaxes.taxInfo object TaxInfo Optional
shop.nonCannabisTaxes.taxInfo.cityTax number Optional
shop.nonCannabisTaxes.taxInfo.created int64 Optional
shop.nonCannabisTaxes.taxInfo.deleted boolean Optional
shop.nonCannabisTaxes.taxInfo.federalTax number Optional
shop.nonCannabisTaxes.taxInfo.id string Optional
shop.nonCannabisTaxes.taxInfo.modified int64 Optional
shop.nonCannabisTaxes.taxInfo.stateTax number Optional
shop.nonCannabisTaxes.taxInfo.updated boolean Optional
shop.nonCannabisTaxes.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
shop.nonCannabisTaxes.taxTables[] array Optional
shop.nonCannabisTaxes.taxTables[].active boolean Optional
shop.nonCannabisTaxes.taxTables[].cityTax object CompoundTaxRate Optional
shop.nonCannabisTaxes.taxTables[].cityTax.active boolean Optional
shop.nonCannabisTaxes.taxTables[].cityTax.activeExciseTax boolean Optional
shop.nonCannabisTaxes.taxTables[].cityTax.companyId string Optional
shop.nonCannabisTaxes.taxTables[].cityTax.compound boolean Optional
shop.nonCannabisTaxes.taxTables[].cityTax.created int64 Optional
shop.nonCannabisTaxes.taxTables[].cityTax.deleted boolean Optional
shop.nonCannabisTaxes.taxTables[].cityTax.dirty boolean Optional
shop.nonCannabisTaxes.taxTables[].cityTax.displayName string Optional
shop.nonCannabisTaxes.taxTables[].cityTax.id string Optional
shop.nonCannabisTaxes.taxTables[].cityTax.modified int64 Optional
shop.nonCannabisTaxes.taxTables[].cityTax.shopId string Optional
shop.nonCannabisTaxes.taxTables[].cityTax.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
shop.nonCannabisTaxes.taxTables[].cityTax.taxRate number Optional
shop.nonCannabisTaxes.taxTables[].cityTax.territory string

Possible values are:

  • Default
  • City
  • County
  • State
  • Federal
Optional
shop.nonCannabisTaxes.taxTables[].cityTax.updated boolean Optional
shop.nonCannabisTaxes.taxTables[].companyId string Optional
shop.nonCannabisTaxes.taxTables[].consumerType string

Possible values are:

  • Other
  • AdultUse
  • MedicinalState
  • MedicinalThirdParty
Optional
shop.nonCannabisTaxes.taxTables[].countyTax object CompoundTaxRate Optional
shop.nonCannabisTaxes.taxTables[].countyTax.active boolean Optional
shop.nonCannabisTaxes.taxTables[].countyTax.activeExciseTax boolean Optional
shop.nonCannabisTaxes.taxTables[].countyTax.companyId string Optional
shop.nonCannabisTaxes.taxTables[].countyTax.compound boolean Optional
shop.nonCannabisTaxes.taxTables[].countyTax.created int64 Optional
shop.nonCannabisTaxes.taxTables[].countyTax.deleted boolean Optional
shop.nonCannabisTaxes.taxTables[].countyTax.dirty boolean Optional
shop.nonCannabisTaxes.taxTables[].countyTax.displayName string Optional
shop.nonCannabisTaxes.taxTables[].countyTax.id string Optional
shop.nonCannabisTaxes.taxTables[].countyTax.modified int64 Optional
shop.nonCannabisTaxes.taxTables[].countyTax.shopId string Optional
shop.nonCannabisTaxes.taxTables[].countyTax.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
shop.nonCannabisTaxes.taxTables[].countyTax.taxRate number Optional
shop.nonCannabisTaxes.taxTables[].countyTax.territory string

Possible values are:

  • Default
  • City
  • County
  • State
  • Federal
Optional
shop.nonCannabisTaxes.taxTables[].countyTax.updated boolean Optional
shop.nonCannabisTaxes.taxTables[].created int64 Optional
shop.nonCannabisTaxes.taxTables[].deleted boolean Optional
shop.nonCannabisTaxes.taxTables[].dirty boolean Optional
shop.nonCannabisTaxes.taxTables[].federalTax object CompoundTaxRate Optional
shop.nonCannabisTaxes.taxTables[].federalTax.active boolean Optional
shop.nonCannabisTaxes.taxTables[].federalTax.activeExciseTax boolean Optional
shop.nonCannabisTaxes.taxTables[].federalTax.companyId string Optional
shop.nonCannabisTaxes.taxTables[].federalTax.compound boolean Optional
shop.nonCannabisTaxes.taxTables[].federalTax.created int64 Optional
shop.nonCannabisTaxes.taxTables[].federalTax.deleted boolean Optional
shop.nonCannabisTaxes.taxTables[].federalTax.dirty boolean Optional
shop.nonCannabisTaxes.taxTables[].federalTax.displayName string Optional
shop.nonCannabisTaxes.taxTables[].federalTax.id string Optional
shop.nonCannabisTaxes.taxTables[].federalTax.modified int64 Optional
shop.nonCannabisTaxes.taxTables[].federalTax.shopId string Optional
shop.nonCannabisTaxes.taxTables[].federalTax.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
shop.nonCannabisTaxes.taxTables[].federalTax.taxRate number Optional
shop.nonCannabisTaxes.taxTables[].federalTax.territory string

Possible values are:

  • Default
  • City
  • County
  • State
  • Federal
Optional
shop.nonCannabisTaxes.taxTables[].federalTax.updated boolean Optional
shop.nonCannabisTaxes.taxTables[].id string Optional
shop.nonCannabisTaxes.taxTables[].modified int64 Optional
shop.nonCannabisTaxes.taxTables[].name string Optional
shop.nonCannabisTaxes.taxTables[].shopId string Optional
shop.nonCannabisTaxes.taxTables[].stateTax object CompoundTaxRate Optional
shop.nonCannabisTaxes.taxTables[].stateTax.active boolean Optional
shop.nonCannabisTaxes.taxTables[].stateTax.activeExciseTax boolean Optional
shop.nonCannabisTaxes.taxTables[].stateTax.companyId string Optional
shop.nonCannabisTaxes.taxTables[].stateTax.compound boolean Optional
shop.nonCannabisTaxes.taxTables[].stateTax.created int64 Optional
shop.nonCannabisTaxes.taxTables[].stateTax.deleted boolean Optional
shop.nonCannabisTaxes.taxTables[].stateTax.dirty boolean Optional
shop.nonCannabisTaxes.taxTables[].stateTax.displayName string Optional
shop.nonCannabisTaxes.taxTables[].stateTax.id string Optional
shop.nonCannabisTaxes.taxTables[].stateTax.modified int64 Optional
shop.nonCannabisTaxes.taxTables[].stateTax.shopId string Optional
shop.nonCannabisTaxes.taxTables[].stateTax.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
shop.nonCannabisTaxes.taxTables[].stateTax.taxRate number Optional
shop.nonCannabisTaxes.taxTables[].stateTax.territory string

Possible values are:

  • Default
  • City
  • County
  • State
  • Federal
Optional
shop.nonCannabisTaxes.taxTables[].stateTax.updated boolean Optional
shop.nonCannabisTaxes.taxTables[].taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
shop.nonCannabisTaxes.taxTables[].taxType string

Possible values are:

  • Default
  • Inherit
  • Custom
  • Exempt
Optional
shop.nonCannabisTaxes.taxTables[].updated boolean Optional
shop.nonCannabisTaxes.useComplexTax boolean Optional
shop.numAllowActiveTrans int32 Optional
shop.onFleetAllowEmptyOrders boolean Optional
shop.onFleetApiKey string Optional
shop.onFleetOrganizationId string Optional
shop.onFleetOrganizationName string Optional
shop.onFleetRequired boolean Optional
shop.onFleetTwoAutoPack boolean Optional
shop.onFleetTwoWay boolean Optional
shop.onFleetTwoWayRevert boolean Optional
shop.onFleetTwoWayUpdateSchedule boolean Optional
shop.onfleetOverrideUrl string Optional
shop.onlineStoreInfo object OnlineStoreInfo Optional
shop.onlineStoreInfo.activeInventoryId string Optional
shop.onlineStoreInfo.cartMinType string

Possible values are:

  • Subtotal
  • SubtotalWithDiscount
Optional
shop.onlineStoreInfo.cartMinimum number Optional
shop.onlineStoreInfo.colorTheme string

Possible values are:

  • Light
  • Dark
Optional
shop.onlineStoreInfo.companyId string Optional
shop.onlineStoreInfo.created int64 Optional
shop.onlineStoreInfo.customCss string Optional
shop.onlineStoreInfo.customMessageETA string Optional
shop.onlineStoreInfo.defaultETA int32 Optional
shop.onlineStoreInfo.deleted boolean Optional
shop.onlineStoreInfo.dirty boolean Optional
shop.onlineStoreInfo.enableDelivery boolean Optional
shop.onlineStoreInfo.enableDeliveryAreaRestrictions boolean Optional
shop.onlineStoreInfo.enableHtmlText boolean Optional
shop.onlineStoreInfo.enableInventory boolean Optional
shop.onlineStoreInfo.enableInventoryType string

Possible values are:

  • All
  • Custom
Optional
shop.onlineStoreInfo.enableOnlinePOS boolean Optional
shop.onlineStoreInfo.enableOnlineShipment boolean Optional
shop.onlineStoreInfo.enableOtherMarketingSource boolean Optional
shop.onlineStoreInfo.enableProductReviews boolean Optional
shop.onlineStoreInfo.enableStorePickup boolean Optional
shop.onlineStoreInfo.enabled boolean Optional
shop.onlineStoreInfo.htmlText string Optional
shop.onlineStoreInfo.id string Optional
shop.onlineStoreInfo.modified int64 Optional
shop.onlineStoreInfo.pageOneMessageBody string Optional
shop.onlineStoreInfo.pageOneMessageTitle string Optional
shop.onlineStoreInfo.restrictedZipCodes[] array of string Optional
shop.onlineStoreInfo.shopId string Optional
shop.onlineStoreInfo.storeHexColor string Optional
shop.onlineStoreInfo.submissionMessage string Optional
shop.onlineStoreInfo.supportEmail string Optional
shop.onlineStoreInfo.updated boolean Optional
shop.onlineStoreInfo.useCustomETA boolean Optional
shop.onlineStoreInfo.viewType string

Possible values are:

  • List
  • Grid
Optional
shop.onlineStoreInfo.websiteOrigins string Optional
shop.onlineStoreInfo.websiteUrl string Optional
shop.orderTags[] array of string Optional
shop.pennyTransactionOption string

Possible values are:

  • DISABLED
  • PER_QUANTITY
  • OVERALL_TRANSACTION
Optional
shop.phoneNumber string Optional
shop.poNote string Optional
shop.poTermCondition string Optional
shop.productPriceIncludeExciseTax boolean Optional
shop.productsTag[] array of string Optional
shop.receiptInfo[] array Optional
shop.receiptInfo[].aboveFreeText string Optional
shop.receiptInfo[].companyId string Optional
shop.receiptInfo[].created int64 Optional
shop.receiptInfo[].deleted boolean Optional
shop.receiptInfo[].dirty boolean Optional
shop.receiptInfo[].emailAttachment object CompanyAsset Optional
shop.receiptInfo[].emailAttachment.active boolean Optional
shop.receiptInfo[].emailAttachment.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
shop.receiptInfo[].emailAttachment.companyId string Optional
shop.receiptInfo[].emailAttachment.created int64 Optional
shop.receiptInfo[].emailAttachment.deleted boolean Optional
shop.receiptInfo[].emailAttachment.id string Optional
shop.receiptInfo[].emailAttachment.key string Optional
shop.receiptInfo[].emailAttachment.largeURL string Optional
shop.receiptInfo[].emailAttachment.largeX2URL string Optional
shop.receiptInfo[].emailAttachment.mediumURL string Optional
shop.receiptInfo[].emailAttachment.modified int64 Optional
shop.receiptInfo[].emailAttachment.name string Optional
shop.receiptInfo[].emailAttachment.origURL string Optional
shop.receiptInfo[].emailAttachment.priority int32 Optional
shop.receiptInfo[].emailAttachment.publicURL string Optional
shop.receiptInfo[].emailAttachment.secured boolean Optional
shop.receiptInfo[].emailAttachment.thumbURL string Optional
shop.receiptInfo[].emailAttachment.type string

Possible values are:

  • Photo
  • Document
  • Kml
Optional
shop.receiptInfo[].emailAttachment.updated boolean Optional
shop.receiptInfo[].emailMessage string Optional
shop.receiptInfo[].enableBrand boolean Optional
shop.receiptInfo[].enableEmployeeId boolean Optional
shop.receiptInfo[].enableEmployeeName boolean Optional
shop.receiptInfo[].enableExciseTaxAsItem boolean Optional
shop.receiptInfo[].enableIncludeItemInSKU boolean Optional
shop.receiptInfo[].enableItemDiscount boolean Optional
shop.receiptInfo[].enableItemDiscountNotes boolean Optional
shop.receiptInfo[].enableLicenseeBusinessName boolean Optional
shop.receiptInfo[].enableMemberAddress boolean Optional
shop.receiptInfo[].enableMemberId boolean Optional
shop.receiptInfo[].enableMemberLoyaltyPoints boolean Optional
shop.receiptInfo[].enableMemberName boolean Optional
shop.receiptInfo[].enableMemberPhoneNo boolean Optional
shop.receiptInfo[].enableNotes boolean Optional
shop.receiptInfo[].enableOrderDateTime boolean Optional
shop.receiptInfo[].enablePreparedByEmployeeId boolean Optional
shop.receiptInfo[].enableShopAddress boolean Optional
shop.receiptInfo[].enableShopLicenseNumber boolean Optional
shop.receiptInfo[].enableShopPhoneNo boolean Optional
shop.receiptInfo[].enabledBottomFreeText boolean Optional
shop.receiptInfo[].enabledFreeText boolean Optional
shop.receiptInfo[].freeText string Optional
shop.receiptInfo[].id string Optional
shop.receiptInfo[].licenseeBusinessName string Optional
shop.receiptInfo[].modified int64 Optional
shop.receiptInfo[].receiptType string

Possible values are:

  • SALES
  • FULFILLMENT
  • DELIVERY
Optional
shop.receiptInfo[].shopId string Optional
shop.receiptInfo[].updated boolean Optional
shop.receivingInventoryId string Optional
shop.requireValidRecDate boolean Optional
shop.restrictIncomingOrderNotifications boolean Optional
shop.restrictedNotificationTerminals[] array of string Optional
shop.restrictedViews boolean Optional
shop.roundOffType string

Possible values are:

  • NONE
  • ROUND_UP
  • ROUND_DOWN
Optional
shop.roundUpMessage string Optional
shop.shopType string

Possible values are:

  • Medicinal
  • Recreational
  • Both
Optional
shop.shortIdentifier string Optional
shop.showDeliveryQueue boolean Optional
shop.showOnlineQueue boolean Optional
shop.showProductByAvailableQuantity boolean Optional
shop.showSpecialQueue boolean Optional
shop.showWalkInQueue boolean Optional
shop.snapshopTime int64 Optional
shop.taxInfo object TaxInfo Optional
shop.taxInfo.cityTax number Optional
shop.taxInfo.created int64 Optional
shop.taxInfo.deleted boolean Optional
shop.taxInfo.federalTax number Optional
shop.taxInfo.id string Optional
shop.taxInfo.modified int64 Optional
shop.taxInfo.stateTax number Optional
shop.taxInfo.updated boolean Optional
shop.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
shop.taxRoundOffType string

Possible values are:

  • ONE_CENT
  • FIVE_CENT
  • NEAREST_DOLLAR
  • UP_DOLLAR
  • DOWN_DOLLAR
Optional
shop.taxTables[] array Optional
shop.taxTables[].active boolean Optional
shop.taxTables[].cityTax object CompoundTaxRate Optional
shop.taxTables[].cityTax.active boolean Optional
shop.taxTables[].cityTax.activeExciseTax boolean Optional
shop.taxTables[].cityTax.companyId string Optional
shop.taxTables[].cityTax.compound boolean Optional
shop.taxTables[].cityTax.created int64 Optional
shop.taxTables[].cityTax.deleted boolean Optional
shop.taxTables[].cityTax.dirty boolean Optional
shop.taxTables[].cityTax.displayName string Optional
shop.taxTables[].cityTax.id string Optional
shop.taxTables[].cityTax.modified int64 Optional
shop.taxTables[].cityTax.shopId string Optional
shop.taxTables[].cityTax.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
shop.taxTables[].cityTax.taxRate number Optional
shop.taxTables[].cityTax.territory string

Possible values are:

  • Default
  • City
  • County
  • State
  • Federal
Optional
shop.taxTables[].cityTax.updated boolean Optional
shop.taxTables[].companyId string Optional
shop.taxTables[].consumerType string

Possible values are:

  • Other
  • AdultUse
  • MedicinalState
  • MedicinalThirdParty
Optional
shop.taxTables[].countyTax object CompoundTaxRate Optional
shop.taxTables[].countyTax.active boolean Optional
shop.taxTables[].countyTax.activeExciseTax boolean Optional
shop.taxTables[].countyTax.companyId string Optional
shop.taxTables[].countyTax.compound boolean Optional
shop.taxTables[].countyTax.created int64 Optional
shop.taxTables[].countyTax.deleted boolean Optional
shop.taxTables[].countyTax.dirty boolean Optional
shop.taxTables[].countyTax.displayName string Optional
shop.taxTables[].countyTax.id string Optional
shop.taxTables[].countyTax.modified int64 Optional
shop.taxTables[].countyTax.shopId string Optional
shop.taxTables[].countyTax.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
shop.taxTables[].countyTax.taxRate number Optional
shop.taxTables[].countyTax.territory string

Possible values are:

  • Default
  • City
  • County
  • State
  • Federal
Optional
shop.taxTables[].countyTax.updated boolean Optional
shop.taxTables[].created int64 Optional
shop.taxTables[].deleted boolean Optional
shop.taxTables[].dirty boolean Optional
shop.taxTables[].federalTax object CompoundTaxRate Optional
shop.taxTables[].federalTax.active boolean Optional
shop.taxTables[].federalTax.activeExciseTax boolean Optional
shop.taxTables[].federalTax.companyId string Optional
shop.taxTables[].federalTax.compound boolean Optional
shop.taxTables[].federalTax.created int64 Optional
shop.taxTables[].federalTax.deleted boolean Optional
shop.taxTables[].federalTax.dirty boolean Optional
shop.taxTables[].federalTax.displayName string Optional
shop.taxTables[].federalTax.id string Optional
shop.taxTables[].federalTax.modified int64 Optional
shop.taxTables[].federalTax.shopId string Optional
shop.taxTables[].federalTax.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
shop.taxTables[].federalTax.taxRate number Optional
shop.taxTables[].federalTax.territory string

Possible values are:

  • Default
  • City
  • County
  • State
  • Federal
Optional
shop.taxTables[].federalTax.updated boolean Optional
shop.taxTables[].id string Optional
shop.taxTables[].modified int64 Optional
shop.taxTables[].name string Optional
shop.taxTables[].shopId string Optional
shop.taxTables[].stateTax object CompoundTaxRate Optional
shop.taxTables[].stateTax.active boolean Optional
shop.taxTables[].stateTax.activeExciseTax boolean Optional
shop.taxTables[].stateTax.companyId string Optional
shop.taxTables[].stateTax.compound boolean Optional
shop.taxTables[].stateTax.created int64 Optional
shop.taxTables[].stateTax.deleted boolean Optional
shop.taxTables[].stateTax.dirty boolean Optional
shop.taxTables[].stateTax.displayName string Optional
shop.taxTables[].stateTax.id string Optional
shop.taxTables[].stateTax.modified int64 Optional
shop.taxTables[].stateTax.shopId string Optional
shop.taxTables[].stateTax.taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
shop.taxTables[].stateTax.taxRate number Optional
shop.taxTables[].stateTax.territory string

Possible values are:

  • Default
  • City
  • County
  • State
  • Federal
Optional
shop.taxTables[].stateTax.updated boolean Optional
shop.taxTables[].taxOrder string

Possible values are:

  • PostTaxed
  • PreTaxed
Optional
shop.taxTables[].taxType string

Possible values are:

  • Default
  • Inherit
  • Custom
  • Exempt
Optional
shop.taxTables[].updated boolean Optional
shop.termSalesOption string

Possible values are:

  • DeviceTerminal
  • AssignedEmployeeTerminal
  • SellerAssignedTerminal
Optional
shop.timeZone string Optional
shop.timezoneOffsetInMinutes int32 Optional
shop.tookanRequired boolean Optional
shop.twilioNumber string Optional
shop.updated boolean Optional
shop.useAssignedEmployee boolean Optional
shop.useComplexTax boolean Optional
toleranceMap object Optional
toleranceMap.<key> map of object ProductWeightTolerance Optional
toleranceMap.<key>.companyId string Optional
toleranceMap.<key>.created int64 Optional
toleranceMap.<key>.deleted boolean Optional
toleranceMap.<key>.enabled boolean Optional
toleranceMap.<key>.endWeight number Optional
toleranceMap.<key>.id string Optional
toleranceMap.<key>.modified int64 Optional
toleranceMap.<key>.name string Optional
toleranceMap.<key>.priority int32 Optional
toleranceMap.<key>.startWeight number Optional
toleranceMap.<key>.unitValue number Optional
toleranceMap.<key>.updated boolean Optional
toleranceMap.<key>.weightKey string

Possible values are:

  • UNIT
  • HALF_GRAM
  • GRAM
  • TWO_GRAMS
  • THREE_GRAMS
  • ONE_EIGHTTH
  • QUARTER
  • HALF
  • OUNCE
  • CUSTOM
  • POUND
  • FLUID_OZ
Optional
toleranceMap.<key>.weightValue number Optional