Antes de chamar a API
Autenticação
Verifique a autenticação.
Disponível a partir de
Verifique se o plano da loja inclui a função API necessária.
Permissões necessárias
Verifique as permissões da chave e as condições dos campos enviados.
Qual plano é necessário
| Disponível a partir de | Descrição |
|---|---|
| BASIC | BASIC inclui a leitura de pedidos e solicitações de clientes, a alteração dos seus estados, do estado de pagamento do pedido e do valor de reembolso registrado. |
| STANDARD | Operações de catálogo, CMS, pesquisa e inventário exigem STANDARD ou um plano superior. |
Lojas com assinaturas existentes recebem os recursos API incluídos no seu plano.
Permissões de uma operação
- A referência apresenta required_scopes para cada operação e conditional_scopes para campos ou alterações sensíveis.
- Ler um recurso não concede permissão para criá-lo, editá-lo ou excluí-lo.
- A emissão de tokens e o contexto continuam exigindo autenticação, mesmo quando nenhuma permissão de recurso é indicada.
Listar
GET/api/v1/products
- Autenticação
Bearer- Disponível a partir de
- STANDARD
- Permissões necessárias
catalog.product:read
Atualizar
PATCH/api/v1/products/{product_id}
- Autenticação
Bearer- Disponível a partir de
- STANDARD
- Permissões necessárias
catalog.product:update
Quando são necessárias permissões adicionais
Atualizar
PATCH/api/v1/products/{product_id}
- Autenticação
Bearer- Disponível a partir de
- STANDARD
- Permissões necessárias
catalog.product:update- Permissões adicionais para determinados campos
- Quando variant_value_ids está presente:
catalog.product_variant:create,catalog.product_variant:update,catalog.product_variant:delete - Quando variants_enabled está presente:
catalog.product_variant:update
- Quando variant_value_ids está presente:
O que acontece ao mudar de plano
Quando a redução do plano elimina uma permissão, ela é removida das chaves API e fica desmarcada e desabilitada no painel administrativo.