Before calling the API
Authentication
Check authentication.
Available from
Check that the store plan includes the API feature you need.
Required permissions
Check the key permissions and the conditions for the fields you send.
Which plan you need
| Available from | Description |
|---|---|
| BASIC | BASIC includes reading orders and customer requests, changing their statuses, changing order payment status and changing the recorded refund amount. |
| STANDARD | Catalog, CMS, search and inventory operations require STANDARD or a higher plan. |
Existing subscribed stores receive the API features included in their plan.
Permissions for an operation
- The reference lists required_scopes for each operation and conditional_scopes for sensitive fields or changes.
- Reading a resource does not grant permission to create, edit or delete it.
- Token issuance and context still require authentication even where no resource scope is listed.
List
GET/api/v1/products
- Authentication
Bearer- Available from
- STANDARD
- Required permissions
catalog.product:read
Update
PATCH/api/v1/products/{product_id}
- Authentication
Bearer- Available from
- STANDARD
- Required permissions
catalog.product:update
When additional permissions are needed
Update
PATCH/api/v1/products/{product_id}
- Authentication
Bearer- Available from
- STANDARD
- Required permissions
catalog.product:update- Additional permissions for selected fields
- When variant_value_ids is included:
catalog.product_variant:create,catalog.product_variant:update,catalog.product_variant:delete - When variants_enabled is included:
catalog.product_variant:update
- When variant_value_ids is included:
What happens when the plan changes
When a downgrade removes a permission, it is removed from API keys and becomes unchecked and disabled in the administrator panel.