BLAZE Developer API: SearchResultBrandResult

Methods

get - Get All Brands

Resource

{
    "limit": "int32",
    "skip": "int32",
    "total": "int64",
    "values": [
        {
            "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",
            "thirdPartyBrandName": "string",
            "updated": "boolean",
            "vendorList": [
                "string"
            ],
            "vendors": [
                {
                    "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",
                    "vendorKey": "string",
                    "vendorType": "string",
                    "website": "string"
                }
            ],
            "website": "string"
        }
    ]
}

Properties

Name	Type	Description	Additional
limit	int32		Optional
skip	int32		Optional
total	int64		Optional
values[]	array		Optional
values[].active	boolean		Optional
values[].brandLogo	object	CompanyAsset	Optional
values[].brandLogo.active	boolean		Optional
values[].brandLogo.assetType	string	Possible values are: `Photo` `Document` `Kml`	Optional
values[].brandLogo.companyId	string		Optional
values[].brandLogo.created	int64		Optional
values[].brandLogo.deleted	boolean		Optional
values[].brandLogo.id	string		Optional
values[].brandLogo.key	string		Optional
values[].brandLogo.largeURL	string		Optional
values[].brandLogo.largeX2URL	string		Optional
values[].brandLogo.mediumURL	string		Optional
values[].brandLogo.modified	int64		Optional
values[].brandLogo.name	string		Optional
values[].brandLogo.origURL	string		Optional
values[].brandLogo.priority	int32		Optional
values[].brandLogo.publicURL	string		Optional
values[].brandLogo.secured	boolean		Optional
values[].brandLogo.thumbURL	string		Optional
values[].brandLogo.type	string	Possible values are: `Photo` `Document` `Kml`	Optional
values[].brandLogo.updated	boolean		Optional
values[].companyId	string		Optional
values[].created	int64		Optional
values[].default	boolean		Optional
values[].deleted	boolean		Optional
values[].externalId	string		Optional
values[].id	string		Optional
values[].modified	int64		Optional
values[].name	string		Optional
values[].phoneNo	string		Optional
values[].thirdPartyBrandName	string		Optional
values[].updated	boolean		Optional
values[].vendorList[]	array of string		Optional
values[].vendors[]	array		Optional
values[].vendors[].accountOwnerId	string		Optional
values[].vendors[].active	boolean		Optional
values[].vendors[].additionalAddressList[]	array		Optional
values[].vendors[].additionalAddressList[].address	string		Optional
values[].vendors[].additionalAddressList[].addressLine2	string		Optional
values[].vendors[].additionalAddressList[].city	string		Optional
values[].vendors[].additionalAddressList[].companyId	string		Optional
values[].vendors[].additionalAddressList[].country	string		Optional
values[].vendors[].additionalAddressList[].created	int64		Optional
values[].vendors[].additionalAddressList[].deleted	boolean		Optional
values[].vendors[].additionalAddressList[].id	string		Optional
values[].vendors[].additionalAddressList[].latitude	number		Optional
values[].vendors[].additionalAddressList[].longitude	number		Optional
values[].vendors[].additionalAddressList[].modified	int64		Optional
values[].vendors[].additionalAddressList[].state	string		Optional
values[].vendors[].additionalAddressList[].updated	boolean		Optional
values[].vendors[].additionalAddressList[].zipCode	string		Optional
values[].vendors[].address	object	Address	Optional
values[].vendors[].address.address	string		Optional
values[].vendors[].address.addressLine2	string		Optional
values[].vendors[].address.city	string		Optional
values[].vendors[].address.companyId	string		Optional
values[].vendors[].address.country	string		Optional
values[].vendors[].address.created	int64		Optional
values[].vendors[].address.deleted	boolean		Optional
values[].vendors[].address.id	string		Optional
values[].vendors[].address.latitude	number		Optional
values[].vendors[].address.longitude	number		Optional
values[].vendors[].address.modified	int64		Optional
values[].vendors[].address.state	string		Optional
values[].vendors[].address.updated	boolean		Optional
values[].vendors[].address.zipCode	string		Optional
values[].vendors[].armsLengthType	string	Possible values are: `ARMS_LENGTH` `NON_ARMS_LENGTH`	Optional
values[].vendors[].assets[]	array		Optional
values[].vendors[].assets[].active	boolean		Optional
values[].vendors[].assets[].assetType	string	Possible values are: `Photo` `Document` `Kml`	Optional
values[].vendors[].assets[].companyId	string		Optional
values[].vendors[].assets[].created	int64		Optional
values[].vendors[].assets[].deleted	boolean		Optional
values[].vendors[].assets[].id	string		Optional
values[].vendors[].assets[].key	string		Optional
values[].vendors[].assets[].largeURL	string		Optional
values[].vendors[].assets[].largeX2URL	string		Optional
values[].vendors[].assets[].mediumURL	string		Optional
values[].vendors[].assets[].modified	int64		Optional
values[].vendors[].assets[].name	string		Optional
values[].vendors[].assets[].origURL	string		Optional
values[].vendors[].assets[].priority	int32		Optional
values[].vendors[].assets[].publicURL	string		Optional
values[].vendors[].assets[].secured	boolean		Optional
values[].vendors[].assets[].thumbURL	string		Optional
values[].vendors[].assets[].type	string	Possible values are: `Photo` `Document` `Kml`	Optional
values[].vendors[].assets[].updated	boolean		Optional
values[].vendors[].backOrderEnabled	boolean		Optional
values[].vendors[].brands[]	array of string		Optional
values[].vendors[].companyId	string		Optional
values[].vendors[].companyLicenses[]	array		Optional
values[].vendors[].companyLicenses[].companyType	string	Possible values are: `DISTRIBUTOR` `CULTIVATOR` `RETAILER` `MANUFACTURER` `TRANSPORTER` `OTHER` `TESTING_FACILITY`	Optional
values[].vendors[].companyLicenses[].created	int64		Optional
values[].vendors[].companyLicenses[].deleted	boolean		Optional
values[].vendors[].companyLicenses[].id	string		Optional
values[].vendors[].companyLicenses[].licenseExpirationDate	int64		Optional
values[].vendors[].companyLicenses[].licenseNumber	string		Optional
values[].vendors[].companyLicenses[].licenseType	string	Possible values are: `RECREATIONAL` `MEDICINAL` `BOTH`	Optional
values[].vendors[].companyLicenses[].modified	int64		Optional
values[].vendors[].companyLicenses[].toDefault	boolean		Optional
values[].vendors[].companyLicenses[].updated	boolean		Optional
values[].vendors[].companyType	string	Possible values are: `DISTRIBUTOR` `CULTIVATOR` `RETAILER` `MANUFACTURER` `TRANSPORTER` `OTHER` `TESTING_FACILITY`	Optional
values[].vendors[].connectedShop	string		Optional
values[].vendors[].contactPerson	string		Optional
values[].vendors[].created	int64		Optional
values[].vendors[].createdBy	string		Optional
values[].vendors[].credits	number		Optional
values[].vendors[].dbaName	string		Optional
values[].vendors[].defaultContactId	string		Optional
values[].vendors[].defaultPaymentTerm	string		Optional
values[].vendors[].deleted	boolean		Optional
values[].vendors[].description	string		Optional
values[].vendors[].email	string		Optional
values[].vendors[].externalId	string		Optional
values[].vendors[].fax	string		Optional
values[].vendors[].firstName	string		Optional
values[].vendors[].id	string		Optional
values[].vendors[].importId	string		Optional
values[].vendors[].lastName	string		Optional
values[].vendors[].licenceType	string	Possible values are: `RECREATIONAL` `MEDICINAL` `BOTH`	Optional
values[].vendors[].licenseExpirationDate	int64		Optional
values[].vendors[].licenseNumber	string		Optional
values[].vendors[].mobileNumber	string		Optional
values[].vendors[].modified	int64		Optional
values[].vendors[].name	string		Optional
values[].vendors[].notes[]	array		Optional
values[].vendors[].notes[].created	int64		Optional
values[].vendors[].notes[].deleted	boolean		Optional
values[].vendors[].notes[].enableOnFleet	boolean		Optional
values[].vendors[].notes[].id	string		Optional
values[].vendors[].notes[].message	string		Optional
values[].vendors[].notes[].modified	int64		Optional
values[].vendors[].notes[].updated	boolean		Optional
values[].vendors[].notes[].writerId	string		Optional
values[].vendors[].notes[].writerName	string		Optional
values[].vendors[].phone	string		Optional
values[].vendors[].qbVendorRef[]	array of object		Optional
values[].vendors[].qbVendorRef[].<key>	map of string		Optional
values[].vendors[].relatedEntity	boolean		Optional
values[].vendors[].salesPerson	string		Optional
values[].vendors[].toDefault	boolean		Optional
values[].vendors[].updated	boolean		Optional
values[].vendors[].vendorKey	string		Optional, read only.
values[].vendors[].vendorType	string	Possible values are: `CUSTOMER` `VENDOR` `BOTH`	Optional
values[].vendors[].website	string		Optional
values[].website	string		Optional

SearchResultBrandResult resource

Methods

Resource

Properties