Permissions

Access tokens use granular permissions to control which API resources they can access. Each token can have one or more permissions assigned.

Available Permissions

PermissionDescriptionEndpoint
products:readRead access to the products catalog, including media, variants, options, and market pricing.GET /api/v1/products
orders:readRead access to orders, including items, addresses, and fulfillment status.GET /api/v1/orders
webhooks:readRead access to webhooks, including their name, type, event, URL, and status.GET /api/v1/webhooks
webhooks:writeCreate, update, and delete webhooks. Maximum 20 webhooks per store.POST/PUT/DELETE /api/v1/webhooks

How Permissions Work

Permission Denied Response

When a token lacks the required permission for an endpoint, the API returns:

403 Forbidden
{
    "status": "error",
    "errors": [
        "insufficient permissions, requires: orders:read"
    ]
}

Best Practices