Brand Resources
The API provides access to four primary resources for brands.
| Resource | Description |
|---|---|
| CRM | Retrieve and manage CRM records |
| Inventory | Retrieve and manage inventory attributes of product listings |
| Orders | Retrieve and manage orders received |
| Products | Retrieve 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.
| Resource | Permission | Endpoint Access |
|---|---|---|
| Orders | Read | GET /orders-received/ /order-event-logs/ /order-sales-reps/ /order-statuses/ /line-items/ /brands/ /order-payments/ /companies/ /company-staff/ /promocodes/ /reports/ |
| Orders | Read & Write | Read 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/ |
| Products | Read | GET /products/ /product-categories/ /product-subcategories/ /brands/ /product-lines/ /product-images/ /strains/ /companies/ /company-staff/ /batches/ /batch-documents/ /product-batches/ |
| Products | Read & Write | Read 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/ |
| Customers | Read | GET /customers/ /contacts/ /activity-entries/ /customer-statuses/ /customer-tiers/ /license-types/ /companies/ /company-staff/ |
| Customers | Read & Write | Read access + POST /customers/ /contacts/ /activity-entries/ /customer-statuses/ PATCH /customers/ /contacts/ /activity-entries/ /customer-statuses/ DELETE /customers/ /contacts/ /activity-entries/ /customer-statuses/ |