API legada/Referência completa/Conector Magento

Produtos do Magento

Lista e consulta produtos com o SKU do Magento e grava o SKU e a marca de lido.

Devolve os produtos no formato da API de produtos, com dois campos a mais: sku_magento (o SKU do mesmo produto no Magento) e is_read (Y se o script de sincronização já leu o produto). Para os demais campos veja Consultar produto.

Listar produtos

GET/api/v1.0/magento_productsAdmin

Listar produtos do conector

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/magentoproductsAdmin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/magento_products. 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_products?items_per_page=10"

Resposta

200Produtos retornados

json

{
  "status": 200,
  "data": [
    {
      "product_id": "0497b6a8-c868-43be-ac21-2abddd24cd3c",
      "product": "Caneca Esmaltada 350 ml",
      "product_code": "CAN-350-AZ",
      "price": "49.90",
      "status": "A",
      "sku_magento": "CAN-350-AZ-MG",
      "is_read": "N"
    }
  ],
  "params": { "items_per_page": 10, "page": 1, "total_items": 1 },
  "products": [ { "product_id": "0497b6a8-c868-43be-ac21-2abddd24cd3c" } ]
}

Campos da resposta

dataarray

Os produtos, com os campos da API de produtos mais sku_magento e is_read.

sku_magentostring

SKU do produto no Magento. Vazio enquanto não for gravado.

is_readstring

YN

Y se o produto já foi lido pelo script.

paramsobject

items_per_page, page e total_items.

productsarray

Cópia de data. Leia data.

Consultar produto

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

Consultar um produto do conector

Parâmetros de caminho

iduuidobrigatório

Id do produto.

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

Mesma operação, caminho alternativo

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

Devolve um produto com o mesmo formato de cada item da lista (sem o envelope).

Atualizar produto

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

Gravar o SKU do Magento num produto

Parâmetros de caminho

iduuidobrigatório

Id do produto.

Corpo da requisição

sku_magentostring

SKU do produto no Magento. Vazio ou 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/magentoproducts/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/magento_products/{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_products/0497b6a8-c868-43be-ac21-2abddd24cd3c" \
  -H "Content-Type: application/json" \
  -d '{"sku_magento":"CAN-350-AZ-MG","is_read":"Y"}'

Resposta

200Produto atualizado

json

{ "product_id": "0497b6a8-c868-43be-ac21-2abddd24cd3c" }

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 um produto que não existe (com o módulo ligado).	`{"message":"product not found","status":404}`
500	Falha ao gravar.	`{"message":"update failed: ...","status":500}`

Veja também

API legada/Referência completa/Conector Magento

Produtos do Magento

Lista e consulta produtos com o SKU do Magento e grava o SKU e a marca de lido.

Listar produtos

GET/api/v1.0/magento_productsAdmin

Listar produtos do conector

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/magentoproductsAdmin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/magento_products. 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_products?items_per_page=10"

Resposta

200Produtos retornados

json

{
  "status": 200,
  "data": [
    {
      "product_id": "0497b6a8-c868-43be-ac21-2abddd24cd3c",
      "product": "Caneca Esmaltada 350 ml",
      "product_code": "CAN-350-AZ",
      "price": "49.90",
      "status": "A",
      "sku_magento": "CAN-350-AZ-MG",
      "is_read": "N"
    }
  ],
  "params": { "items_per_page": 10, "page": 1, "total_items": 1 },
  "products": [ { "product_id": "0497b6a8-c868-43be-ac21-2abddd24cd3c" } ]
}

Campos da resposta

dataarray

Os produtos, com os campos da API de produtos mais sku_magento e is_read.

sku_magentostring

SKU do produto no Magento. Vazio enquanto não for gravado.

is_readstring

YN

Y se o produto já foi lido pelo script.

paramsobject

items_per_page, page e total_items.

productsarray

Cópia de data. Leia data.

Consultar produto

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

Consultar um produto do conector

Parâmetros de caminho

iduuidobrigatório

Id do produto.

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

Mesma operação, caminho alternativo

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

Devolve um produto com o mesmo formato de cada item da lista (sem o envelope).

Atualizar produto

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

Gravar o SKU do Magento num produto

Parâmetros de caminho

iduuidobrigatório

Id do produto.

Corpo da requisição

sku_magentostring

SKU do produto no Magento. Vazio ou 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/magentoproducts/{id}Admin

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/magento_products/{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_products/0497b6a8-c868-43be-ac21-2abddd24cd3c" \
  -H "Content-Type: application/json" \
  -d '{"sku_magento":"CAN-350-AZ-MG","is_read":"Y"}'

Resposta

200Produto atualizado

json

{ "product_id": "0497b6a8-c868-43be-ac21-2abddd24cd3c" }

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 um produto que não existe (com o módulo ligado).	`{"message":"product not found","status":404}`
500	Falha ao gravar.	`{"message":"update failed: ...","status":500}`