VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa

Conector Magento

Como o conector Magento troca pedidos, produtos e lojas com a plataforma e o mapa das nove operações.

O conector Magento liga a plataforma a uma loja Magento que vende os mesmos produtos. Um script de sincronização do lado do Magento lê os pedidos, produtos e lojas (sellers) da plataforma e devolve o que quer registrar: o SKU do produto no Magento, o id do seller no Magento e a marca de "já lido". Estas rotas seguem o contrato da API 1.0, que esses scripts já conhecem.

Pontos-chave
  • Só administradores chamam estas rotas (HTTP Basic e-mail:chave_de_api ou Bearer <JWT>).
  • O módulo do conector Magento precisa estar ligado na loja. Desligado, toda rota responde 404 endpoint not available, como se não existisse.
  • A lista vem no formato {{ "status": 200, "data": [...], "params": {{...}} }}, com a lista repetida numa chave com o nome da entidade (orders, products, stores).
  • Cada entidade tem um segundo nome sem sublinhado (/magentoorders), que faz o mesmo.
  • is_read usa Y ou N na leitura e aceita Y/N, true/false ou 1/0 na escrita.

Como funciona

Fluxo típico de sincronização

  1. Ler os sellers

    Listar lojas e gravar o id de cada seller no Magento com PUT.

  2. Ler os produtos

    Listar produtos e gravar o sku_magento de cada um.

  3. Ler os pedidos

    Listar pedidos, filtrando por status.

Conceitos importantes

Ids

Pedidos, produtos e lojas usam UUID. Em magento_stores/{id} o {id} é, de preferência, o id do seller no Magento (o valor gravado em magento_id_seller); se nada casar, a rota tenta o UUID da loja.

Endpoints

MétodoCaminhoPara que serveAutenticação
GET/api/v1.0/magento_ordersListar pedidosAdministrador
GET/api/v1.0/magento_orders/{id}Consultar pedidoAdministrador
PUT/api/v1.0/magento_orders/{id}Atualizar pedidoAdministrador
GET/api/v1.0/magento_productsListar produtosAdministrador
GET/api/v1.0/magento_products/{id}Consultar produtoAdministrador
PUT/api/v1.0/magento_products/{id}Atualizar produtoAdministrador
GET/api/v1.0/magento_storesListar lojasAdministrador
GET/api/v1.0/magento_stores/{id}Consultar lojaAdministrador
PUT/api/v1.0/magento_stores/{id}Atualizar lojaAdministrador

Cada linha vale também com o nome sem sublinhado (/api/v1.0/magentoorders, /api/v1.0/magentoproducts, /api/v1.0/magentostores). As missões de campo, que usam o mesmo módulo, estão em Missões de campo.

Erros comuns

  • Chamar com o módulo desligado. Volta 404 endpoint not available, não 403. Ligue o módulo no painel.
  • Esperar items_per_page limitado. Estas listas não impõem teto; peça páginas de tamanho razoável.
  • Passar o UUID da loja achando que é o id do Magento. Funciona só como segunda tentativa; grave o magento_id_seller e use-o.
  • Mandar PUT vazio. Responde 200 sem alterar nada.

Próximos passos

Listar pedidos
Pedidos no formato da API 1.0.
Produtos
Leia produtos e grave o SKU do Magento.
Anterior
Pedidos do cliente
Próxima
Pedidos do Magento
Nesta página
  • Como funciona
  • Fluxo típico de sincronização
  • Conceitos importantes
  • Ids
  • Endpoints
  • Erros comuns
  • Próximos passos