Brand Resources

The API provides access to four primary resources for brands.

ResourceDescription
CRMRetrieve and manage CRM records
InventoryRetrieve and manage inventory attributes of product listings
OrdersRetrieve and manage orders received
ProductsRetrieve and manage product listings

Permissions

Application permissions define the methods and endpoints that the API key can access. The table below lists each permission and the methods and endpoints it grants access to.

ResourcePermissionEndpoint Access
OrdersReadGET

/orders-received/
/order-event-logs/
/order-sales-reps/
/order-statuses/
/line-items/
/brands/
/order-payments/
/companies/
/company-staff/
/promocodes/
/reports/
OrdersRead & WriteRead access +

POST

/orders-received/.../transition/
/order-payments/
/order-sales-reps/
/promocodes/
/reports/

PATCH

/orders-received/
/line-items/
/promocodes/
/reports/

DELETE

/orders-received/
/order-sales-reps/
/line-items/
/promocodes/
/reports/
ProductsReadGET

/products/
/product-categories/
/product-subcategories/
/brands/
/product-lines/
/product-images/
/strains/
/companies/
/company-staff/
/batches/
/batch-documents/
/product-batches/
ProductsRead & WriteRead access +

GET

/licenses/

POST

/products/
/product-lines/
/product-images/
/strains/
/batches/
/batch-documents/
/product-batches/

PATCH

/products/
/product-lines/
/batches/

DELETE

/products/
/product-images/
/batches/
/batch-documents/
/product-batches/
CustomersReadGET

/customers/
/contacts/
/activity-entries/
/customer-statuses/
/customer-tiers/
/license-types/
/companies/
/company-staff/
CustomersRead & WriteRead access +

POST

/customers/
/contacts/
/activity-entries/
/customer-statuses/

PATCH

/customers/
/contacts/
/activity-entries/
/customer-statuses/

DELETE

/customers/
/contacts/
/activity-entries/
/customer-statuses/
Last Updated: