Quickstart

This guide walks through the shortest path to a working integration.

1. Request Access

BudSense will provide your client_id and client_secret.

When requesting access, include the company and location accounts your integration needs. Access is scoped to the accounts assigned to your partner integration.

2. Authenticate

Use the OAuth2 Client Credentials flow to get an access token.

• Endpoint: https://api.budsense.com/oauth/token
• Content-Type: application/x-www-form-urlencoded
• Scope: budsense/read

See Authentication for full token details.

3. Verify Your Configuration

Call GET /v1/partner after authentication to confirm:

• your partner integration is enabled
• the assigned companies and locations are present
• webhook settings are correct (if used)

4. Fetch Variant Data

Call POST /v1/{companyId}/variants/batch-get with at least one of:

• barcodes
• skus

Notes:

• Requests and responses use application/json.
• locationId is optional. Omit it for company-scoped requests.
• stateCode is used with SKU lookups and must match the values in the SKUs and Provinces reference.
• Maximum 500 barcodes and 500 SKUs per request.

5. Enable Webhooks (Optional)

To receive update notifications, configure your webhook URL via PUT /v1/partner.

• URL must be public HTTPS
• endpoint must accept POST
• your service should return a 2xx response quickly

See Webhook Setup.

6. Handle Errors and Limits

• Use retries with backoff when you receive 429 Too Many Requests
• handle 400, 404, and 500 responses gracefully

See Rate Limits and Error Reference.