API legada/Referência completa/Conector Magento

Lojas do Magento

Lista e consulta os sellers com o id do Magento e grava esse id e a marca de lido.

Uma loja aqui é um seller (lojista) da plataforma. A rota devolve os dados do seller e dois campos do conector: magento_id_seller (o id do mesmo seller no Magento) e is_read (Y se o script já leu o seller). O campo company_id é o UUID do seller.

Listar lojas

GET/api/v1.0/magento_storesAdmin

Listar lojas do conector

A lista é ordenada pelo nome da empresa.

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página. Valor menor que 1 ou inválido volta ao padrão.

GET/api/v1.0/magentostoresAdmin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/magento_stores. Use este caminho se o seu cliente já foi escrito para ele (o nome da entidade sem o sublinhado).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/magento_stores?items_per_page=10"

Resposta

200Lojas retornadas

json

{
  "status": 200,
  "data": [
    {
      "company_id": "bdae95a3-b60c-4985-beee-aacd4b886486",
      "company": "Vendor Two LTDA",
      "company_name": "Vendor Two LTDA",
      "status": "A",
      "email": "contato@vendortwo.example.com",
      "phone": "",
      "url": "",
      "address": "",
      "city": "",
      "state": "",
      "country": "",
      "zipcode": "",
      "storefront": "vendor-two-ltda.example.com.br",
      "slug": "vendor-two-ltda",
      "logo_url": "",
      "magento_id_seller": "1457",
      "is_read": "N"
    }
  ],
  "params": { "items_per_page": 10, "page": 1, "total_items": 1 },
  "stores": [ { "company_id": "bdae95a3-b60c-4985-beee-aacd4b886486" } ]
}

Campos da resposta

company_iduuid

Id do seller.

companystring

Nome do seller.

company_namestring

Razão social ou nome da empresa.

statusstring

Status do seller (A ativo).

emailstring

E-mail de contato.

phonestring

Telefone.

urlstring

Site do seller.

addressstring

Endereço. Os campos city, state, country e zipcode completam o endereço.

storefrontstring

Endereço da vitrine do seller.

slugstring

Identificador curto usado na URL.

logo_urlstring

Endereço do logotipo.

magento_id_sellerstring

Id do seller no Magento. Vazio enquanto não for gravado.

is_readstring

YN

Y se o seller já foi lido pelo script.

Consultar loja

GET/api/v1.0/magento_stores/{id}Admin

Consultar uma loja do conector

Parâmetros de caminho

idstringobrigatório

Id do seller no Magento (magento_id_seller). Se nenhum seller tiver esse valor, a rota tenta o UUID do seller.

GET/api/v1.0/magentostores/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/magento_stores/{id}. Use este caminho se o seu cliente já foi escrito para ele (o nome da entidade sem o sublinhado).

Devolve um seller no mesmo formato de cada item da lista (sem o envelope).

Atualizar loja

PUT/api/v1.0/magento_stores/{id}Admin

Gravar o id do Magento numa loja

Parâmetros de caminho

idstringobrigatório

Id do seller no Magento ou UUID do seller, como em GET.

Corpo da requisição

magento_id_sellerstring

Id do seller no Magento. Ausente não altera o valor.

is_readstring

YN

Marca de lido. Aceita Y/N, true/false ou 1/0; qualquer outro texto vale "não lido".

PUT/api/v1.0/magentostores/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/magento_stores/{id}. Use este caminho se o seu cliente já foi escrito para ele (o nome da entidade sem o sublinhado).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" -X PUT "$BASE_URL/api/v1.0/magento_stores/bdae95a3-b60c-4985-beee-aacd4b886486" \
  -H "Content-Type: application/json" \
  -d '{"magento_id_seller":"1457","is_read":"Y"}'

Resposta

200Loja atualizada

json

{ "company_id": "bdae95a3-b60c-4985-beee-aacd4b886486" }

Erros

Status	Quando	Corpo de exemplo
401	Sem credencial.	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	Credencial válida, mas de quem não é administrador.	`{"message":"Forbidden: admin scope required","status":403}`
404	O módulo do conector Magento está desligado na loja.	`{"message":"endpoint not available","status":404}`
400	Corpo que não é JSON, ou valor recusado.	`{"message":"invalid request body","status":400}`
404	`GET` de uma loja que não existe (com o módulo ligado).	`{"message":"store not found","status":404}`
500	Falha ao gravar.	`{"message":"update failed: ...","status":500}`

Veja também

API legada/Referência completa/Conector Magento

Lojas do Magento

Lista e consulta os sellers com o id do Magento e grava esse id e a marca de lido.

Listar lojas

GET/api/v1.0/magento_storesAdmin

Listar lojas do conector

A lista é ordenada pelo nome da empresa.

Parâmetros de consulta

pageintegerpadrão: 1

Página, a partir de 1.

items_per_pageintegerpadrão: 10

Itens por página. Valor menor que 1 ou inválido volta ao padrão.

GET/api/v1.0/magentostoresAdmin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/magento_stores. Use este caminho se o seu cliente já foi escrito para ele (o nome da entidade sem o sublinhado).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/magento_stores?items_per_page=10"

Resposta

200Lojas retornadas

json

{
  "status": 200,
  "data": [
    {
      "company_id": "bdae95a3-b60c-4985-beee-aacd4b886486",
      "company": "Vendor Two LTDA",
      "company_name": "Vendor Two LTDA",
      "status": "A",
      "email": "contato@vendortwo.example.com",
      "phone": "",
      "url": "",
      "address": "",
      "city": "",
      "state": "",
      "country": "",
      "zipcode": "",
      "storefront": "vendor-two-ltda.example.com.br",
      "slug": "vendor-two-ltda",
      "logo_url": "",
      "magento_id_seller": "1457",
      "is_read": "N"
    }
  ],
  "params": { "items_per_page": 10, "page": 1, "total_items": 1 },
  "stores": [ { "company_id": "bdae95a3-b60c-4985-beee-aacd4b886486" } ]
}

Campos da resposta

company_iduuid

Id do seller.

companystring

Nome do seller.

company_namestring

Razão social ou nome da empresa.

statusstring

Status do seller (A ativo).

emailstring

E-mail de contato.

phonestring

Telefone.

urlstring

Site do seller.

addressstring

Endereço. Os campos city, state, country e zipcode completam o endereço.

storefrontstring

Endereço da vitrine do seller.

slugstring

Identificador curto usado na URL.

logo_urlstring

Endereço do logotipo.

magento_id_sellerstring

Id do seller no Magento. Vazio enquanto não for gravado.

is_readstring

YN

Y se o seller já foi lido pelo script.

Consultar loja

GET/api/v1.0/magento_stores/{id}Admin

Consultar uma loja do conector

Parâmetros de caminho

idstringobrigatório

Id do seller no Magento (magento_id_seller). Se nenhum seller tiver esse valor, a rota tenta o UUID do seller.

GET/api/v1.0/magentostores/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/magento_stores/{id}. Use este caminho se o seu cliente já foi escrito para ele (o nome da entidade sem o sublinhado).

Devolve um seller no mesmo formato de cada item da lista (sem o envelope).

Atualizar loja

PUT/api/v1.0/magento_stores/{id}Admin

Gravar o id do Magento numa loja

Parâmetros de caminho

idstringobrigatório

Id do seller no Magento ou UUID do seller, como em GET.

Corpo da requisição

magento_id_sellerstring

Id do seller no Magento. Ausente não altera o valor.

is_readstring

YN

Marca de lido. Aceita Y/N, true/false ou 1/0; qualquer outro texto vale "não lido".

PUT/api/v1.0/magentostores/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/magento_stores/{id}. Use este caminho se o seu cliente já foi escrito para ele (o nome da entidade sem o sublinhado).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" -X PUT "$BASE_URL/api/v1.0/magento_stores/bdae95a3-b60c-4985-beee-aacd4b886486" \
  -H "Content-Type: application/json" \
  -d '{"magento_id_seller":"1457","is_read":"Y"}'

Resposta

200Loja atualizada

json

{ "company_id": "bdae95a3-b60c-4985-beee-aacd4b886486" }

Erros

Status	Quando	Corpo de exemplo
401	Sem credencial.	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
403	Credencial válida, mas de quem não é administrador.	`{"message":"Forbidden: admin scope required","status":403}`
404	O módulo do conector Magento está desligado na loja.	`{"message":"endpoint not available","status":404}`
400	Corpo que não é JSON, ou valor recusado.	`{"message":"invalid request body","status":400}`
404	`GET` de uma loja que não existe (com o módulo ligado).	`{"message":"store not found","status":404}`
500	Falha ao gravar.	`{"message":"update failed: ...","status":500}`