API legada/Referência completa/Conector Magento

Pedidos do Magento

Lista e consulta pedidos no formato da API 1.0 e grava campos do Magento num pedido.

Estas rotas entregam ao script do Magento os pedidos da loja e recebem de volta os dados que só o Magento conhece (o número do pedido lá, tipo de pagamento, parcelas). Os pedidos têm o mesmo formato da API de pedidos: veja os campos em Listar pedidos e Consultar pedido.

Listar pedidos

GET/api/v1.0/magento_ordersAdmin

Listar pedidos 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.

statusstring

Filtra pelo status do pedido, em letra (O, P, C, F, D, B, I).

GET/api/v1.0/magentoordersAdmin

Mesma operação, caminho alternativo

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

Resposta

200Pedidos retornados

json

{
  "status": 200,
  "data": [
    {
      "order_id": "a8a3c7a3-5f15-45a8-a385-4f20fbf8b722",
      "user_id": "f12f30a9-cbec-40ba-98f1-b7fa8f2e8e10",
      "total": "225.00",
      "status": "O",
      "timestamp": 1791687385,
      "order_number": "PEDIDO-20261010-0004",
      "email": "maria.souza@example.com"
    }
  ],
  "params": { "items_per_page": 10, "page": 1, "total_items": 1 },
  "orders": [ { "order_id": "a8a3c7a3-5f15-45a8-a385-4f20fbf8b722" } ]
}

Campos da resposta

statusinteger

Sempre 200.

dataarray

Os pedidos, com os campos da API de pedidos (ids em UUID, valores em texto decimal, datas em Unix).

paramsobject

items_per_page, page e total_items.

ordersarray

Cópia de data, mantida para clientes novos. Leia data.

Consultar pedido

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

Consultar um pedido do conector

Devolve o pedido completo, no mesmo formato de Consultar pedido (itens, endereços, pagamento).

Parâmetros de caminho

iduuidobrigatório

Id do pedido.

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

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/magento_orders/{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" "$BASE_URL/api/v1.0/magento_orders/a8a3c7a3-5f15-45a8-a385-4f20fbf8b722"

Atualizar pedido

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

Gravar campos do Magento num pedido

Recebe os dados do Magento sobre o pedido. Todos os campos são opcionais e vão em texto, exceto fraude, que é inteiro.

Parâmetros de caminho

iduuidobrigatório

Id do pedido.

Corpo da requisição

magento_order_idstring

Número do pedido no Magento.

braspag_order_typestring

Tipo do pedido no meio de pagamento.

braspag_payment_idstring

Id do pagamento no meio de pagamento.

is_express_deliverystring

Entrega expressa (Y ou N).

store_idstring

Loja do Magento.

pedido_entregastring

Referência do pedido de entrega.

total_vendedorstring

Total do seller.

taxa_manuseiostring

Taxa de manuseio.

total_comissaostring

Total da comissão.

coupon_namestring

Nome do cupom usado.

installmentsstring

Número de parcelas.

installments_pricestring

Valor da parcela.

num_ordersstring

Quantidade de pedidos do grupo.

all_orders_totalstring

Total de todos os pedidos do grupo.

fraudeinteger

Marca de fraude.

order_creation_timestampstring

Momento da criação no Magento.

order_accepted_timestampstring

Momento do aceite no Magento.

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

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/magento_orders/{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_orders/a8a3c7a3-5f15-45a8-a385-4f20fbf8b722" \
  -H "Content-Type: application/json" \
  -d '{"magento_order_id":"M-100045","is_express_delivery":"N","installments":"3"}'

Resposta

200Pedido confirmado

json

{ "order_id": "a8a3c7a3-5f15-45a8-a385-4f20fbf8b722" }

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.	`{"message":"invalid request body","status":400}`
404	`GET` de um pedido que não existe (com o módulo ligado).	`{"message":"order not found","status":404}`

Veja também

API legada/Referência completa/Conector Magento

Pedidos do Magento

Lista e consulta pedidos no formato da API 1.0 e grava campos do Magento num pedido.

Listar pedidos

GET/api/v1.0/magento_ordersAdmin

Listar pedidos 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.

statusstring

Filtra pelo status do pedido, em letra (O, P, C, F, D, B, I).

GET/api/v1.0/magentoordersAdmin

Mesma operação, caminho alternativo

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

Resposta

200Pedidos retornados

json

{
  "status": 200,
  "data": [
    {
      "order_id": "a8a3c7a3-5f15-45a8-a385-4f20fbf8b722",
      "user_id": "f12f30a9-cbec-40ba-98f1-b7fa8f2e8e10",
      "total": "225.00",
      "status": "O",
      "timestamp": 1791687385,
      "order_number": "PEDIDO-20261010-0004",
      "email": "maria.souza@example.com"
    }
  ],
  "params": { "items_per_page": 10, "page": 1, "total_items": 1 },
  "orders": [ { "order_id": "a8a3c7a3-5f15-45a8-a385-4f20fbf8b722" } ]
}

Campos da resposta

statusinteger

Sempre 200.

dataarray

Os pedidos, com os campos da API de pedidos (ids em UUID, valores em texto decimal, datas em Unix).

paramsobject

items_per_page, page e total_items.

ordersarray

Cópia de data, mantida para clientes novos. Leia data.

Consultar pedido

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

Consultar um pedido do conector

Devolve o pedido completo, no mesmo formato de Consultar pedido (itens, endereços, pagamento).

Parâmetros de caminho

iduuidobrigatório

Id do pedido.

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

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de GET /api/v1.0/magento_orders/{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" "$BASE_URL/api/v1.0/magento_orders/a8a3c7a3-5f15-45a8-a385-4f20fbf8b722"

Atualizar pedido

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

Gravar campos do Magento num pedido

Recebe os dados do Magento sobre o pedido. Todos os campos são opcionais e vão em texto, exceto fraude, que é inteiro.

Parâmetros de caminho

iduuidobrigatório

Id do pedido.

Corpo da requisição

magento_order_idstring

Número do pedido no Magento.

braspag_order_typestring

Tipo do pedido no meio de pagamento.

braspag_payment_idstring

Id do pagamento no meio de pagamento.

is_express_deliverystring

Entrega expressa (Y ou N).

store_idstring

Loja do Magento.

pedido_entregastring

Referência do pedido de entrega.

total_vendedorstring

Total do seller.

taxa_manuseiostring

Taxa de manuseio.

total_comissaostring

Total da comissão.

coupon_namestring

Nome do cupom usado.

installmentsstring

Número de parcelas.

installments_pricestring

Valor da parcela.

num_ordersstring

Quantidade de pedidos do grupo.

all_orders_totalstring

Total de todos os pedidos do grupo.

fraudeinteger

Marca de fraude.

order_creation_timestampstring

Momento da criação no Magento.

order_accepted_timestampstring

Momento do aceite no Magento.

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

Mesma operação, caminho alternativo

Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/magento_orders/{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_orders/a8a3c7a3-5f15-45a8-a385-4f20fbf8b722" \
  -H "Content-Type: application/json" \
  -d '{"magento_order_id":"M-100045","is_express_delivery":"N","installments":"3"}'

Resposta

200Pedido confirmado

json

{ "order_id": "a8a3c7a3-5f15-45a8-a385-4f20fbf8b722" }

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.	`{"message":"invalid request body","status":400}`
404	`GET` de um pedido que não existe (com o módulo ligado).	`{"message":"order not found","status":404}`