Documentação - Acelera Magalu

Recursos da Api

A API do Magalu conta hoje com 5 módulos que permitem gerenciar todo fluxo de publicação de produtos, controle de preço e estoque, gestão de pedidos, emissão de etiquetas, cotação de frete, gestão de pedidos fulfillment entre outros. A API do Magalu está disponível em dentro de um Swagger de acesso público, atualmente o Magalu tem dois Swaggers, um para cada ambiente:

Homologação - https://api.integracommerce.com.br/swagger/index.html
Produção - https://in.integracommerce.com.br/swagger/index.html


              API Magalu Identity Provider
              
              - Homologação - https://api.integracommerce.com.br
              - Produção - https://in.integracommerce.com.br

OBS: Os recursos abaixo não funcionam dentro do ambiente de Homologação (sandbox):
OrderQueue - GET e PUT
Order - POST ShippingLabels
NFE - GET

Attribute

Atributos são características que acompanham produtos e/ou skus. Exemplo: Cor, tamanho, voltagem, etc. Na Api do Magalu Marketplace é possível recuperar os atributos através do verbo GET.

IMPORTANTE - Características do Produto e Atributos de SKU(variação)

Características do Produto: informações comuns a todas as variações daquele produto. Como por exemplo conteúdo da embalagem, resistência à água, tempo de duração da bateria entre outras. Estas informações podem ser entendidas como a Ficha Técnica do Produto. Estas informações devem ser cadastradas dentro do Produto Pai, via POST Product.

Atributos de SKU(Variações): informações exclusivas de cada sku(variação), como cor, voltagem, tamanho entre outras. Devem ser cadastradas dentro do SKU, via POST SKU.

Get Attribute

Rota - ( API Magalu Identity Provider ) /api/Attribute

API Magalu Identity Provider
Homologação - https://api.integracommerce.com.br
Produção - https://in.integracommerce.com.br

Detalhes da Requisição
Parâmetros
isSKU - Informe true ou false para trazer os atributos do SKU
isProduct - Informe true ou false para trazer os atributos do Product
page - Informe a página atual
perPage - Informe a quantidade de itens da página


              curl -X 
              'GET' \ 'https://in.integracommerce.com.br/api/Attribute?isSku=true&isProduct=false&page=1&perPage=1' \
              -H 'accept: */*'

Enpointlimit

Este recurso tem a finalidade de recuperar o ratelimit de todos os endpoints da API do Magalu Marketplace. O ratelimit é único por aplicação consentida, assim, um seller que tem por exemplo consentimento para duas aplicações, não terá problema de concorrência entre as aplicações consentidas.

Get Endpointlimit

Rota - ( API Magalu Identity Provider ) /api/EndPointLimit

API Magalu Identity Provider
Homologação - https://api.integracommerce.com.br
Produção - https://in.integracommerce.com.br


              curl -X 'GET'\
              'https://in.integracommerce.com.br/api/EndPointLimit' \
              -H 'accept: */*'

Invoiced

Este recurso tem a finalidade tem a finalidade de atualizar os dados fiscais de um pedido. Assim, quando você tiver um pedido que está com a nota fiscal inválida, você poderá utilizar este recurso para corrigir a mesma.

Put Invoiced

Rota - ( API Magalu Identity Provider ) /api/Invoiced

API Magalu Identity Provider
Homologação - https://api.integracommerce.com.br
Produção - https://in.integracommerce.com.br

Detalhes da Requisição
Parâmetros
idOrder - Informe o id do pedido em questão
key, line, number, issueDate - Informe os dados atualizados da nota fiscal.


              curl -X 'PUT' \
              'https://in.integracommerce.com.br/api/v1/invoice/a' \
              -H 'accept: */*' \
              -H 'Content-Type: application/json-patch+json' \
              -d '{
              "key": "string",
              "line": "string",
              "number": "string",
              "issueDate": "2023-08-23T19:58:18.029Z"
            }'

Nfes

Este recurso tem a finalidade de recuperar as notas fiscais de pedidos que são do tipo fulfillment. Todos os pedidos que são do tipo fulfillment são operados totalmente pelo Magalu, assim, o time do Magalu é responsável por todos os processos logísticos e fiscais do pedido, realizando a emissão de notas fiscais, despacho e entrega do pedido. Com este endpoint é possível recuperar todas as notas fiscais emitidas pelo serviço do fulfillment(utilizando os dados do seller).

OBS - Todos os pedidos fulfillment são identificados através do campo ShippedCarrierName, onde informamos “Magalu Entregas - Fulfillment”. Este campo está disponível dentro do JSON Order.
OBS II - Este recurso retorna todas as notas fiscais que foram emitidas pelo fulfillment do Magalu em nome do seller em questão.

Post Nfes

Rota - ( API Magalu Identity Provider ) api/v1/invoiced/{idOrder}

API Magalu Identity Provider
Homologação - https://api.integracommerce.com.br
Produção - https://in.integracommerce.com.br

Claro, aqui está a adaptação conforme o padrão fornecido:

Order

Este recurso tem a finalidade de manipular os pedidos no Magalu Marketplace. Com ele é possível ler e atualizar pedidos via API. O Magalu Marketplace é totalmente passivo na integração, deste modo, não notificamos via webhook nenhum evento de pedido. Pedidos novos são postados na fila (OrderQueue) e informações e atualizações de pedidos são realizadas através do recurso Order.

GET Order By Id

Rota - ( API Magalu Identity Provider ) /api/Order/{Id}

API Magalu Identity Provider
Homologação - https://api.integracommerce.com.br
Produção - https://in.integracommerce.com.br

Detalhes da Requisição
Parâmetros
Id - Id do pedido em questão (Utilize o LU- )


            curl -X 'GET' \
              'https://in.integracommerce.com.br/api/Order/LU-1234' \
              -H 'accept: */*'

GET Order

Rota - ( API Magalu Identity Provider ) /api/Order/{filters}

API Magalu Identity Provider
Homologação - https://api.integracommerce.com.br
Produção - https://in.integracommerce.com.br

Detalhes da Requisição
Parâmetros
Page - Página atual - obrigatório
PerPage - Itens por página - obrigatório
Status - Status do pedido - opcional
StartDate - Data inicial - opcional
EndDate - Data final - opcional


            curl -X 'GET' \
              'https://in.integracommerce.com.br/api/Order?page=1&perPage=10' \
              -H 'accept: */*'

GET Order V2

Rota - ( API Magalu Identity Provider ) /api/Order/GetAllV2/{filters}

API Magalu Identity Provider
Homologação - https://api.integracommerce.com.br
Produção - https://in.integracommerce.com.br

Detalhes da Requisição
Parâmetros
Page - Página atual - obrigatório
PerPage - Itens por página - obrigatório
Status - Status do pedido - opcional
StartDate - Data inicial - opcional
EndDate - Data final - opcional


            curl -X 'GET' \
            'https://in.integracommerce.com.br/api/Order/GetAllV2?page=1&perPage=10' \
            -H 'accept: */*'

PUT Order

Para atualizar os pedidos no Magalu Marketplace, você deve se atentar às informações obrigatórias para cada status de pedido. Os pedidos possuem status crescentes e unidirecionais, ou seja, uma vez que um pedido atinge um determinado status ele não pode mais retornar ao status anterior.

PUT Order

Rota - ( API Magalu Identity Provider ) /api/Order

API Magalu Identity Provider
Homologação - https://api.integracommerce.com.br
Produção - https://in.integracommerce.com.br

Status dos Pedidos

New - Pedido novo, aguardando o pagamento

Approved - Pedido com pagamento aprovado

Processing - Pedido em separação de estoque

Invoiced - Pedido com nota fiscal emitida

Shipped - Pedido despachado

Delivered - Pedido entregue

Canceled - Pedido cancelado

Exemplos de Requisição para Atualização de Status

Atualizar para "Processing"

{
              "IdOrder": "string",
              "OrderStatus": "PROCESSING"
            }

Atualizar para "Invoiced"

{
              "IdOrder": "string",
              "OrderStatus": "INVOICED",
              "InvoicedNumber": "string",
              "InvoicedLine": 0,
              "InvoicedIssueDate": "2016-06-23T10:59:50.381Z",
              "InvoicedKey": "string",
              "InvoicedDanfeXml": "string"
            }

Atualizar para "Shipped"

{
              "IdOrder": "string",
              "OrderStatus": "SHIPPED",
              "ShippedTrackingUrl": "string",
              "ShippedTrackingProtocol": "string",
              "ShippedEstimatedDelivery": "2016-06-23T10:59:50.381Z",
              "ShippedCarrierDate": "2016-06-23T10:59:50.381Z",
              "ShippedCarrierName": "string"
            }

Atualizar para "Delivered"

{
              "IdOrder": "string",
              "OrderStatus": "DELIVERED",
              "DeliveredDate": "2016-06-23T10:59:50.381Z"
            }

OBS: Os pedidos não podem retornar ao status anterior após serem atualizados.

Claro, aqui estão os trechos adaptados conforme o padrão fornecido: ```html

POST ShippingLabels

Este recurso serve para gerar as etiquetas dos pedidos do tipo Magalu Entregas via API. Os formatos entregues são PDF ou ZPL, sendo possível solicitar as etiquetas de até 20 pedidos por requisição. Todos os pedidos que são do tipo Magalu Entregas serão disponibilizados com o campo “ShippedCarrierName” preenchido com uma das variações abaixo:
- Magalu Entregas
- Magalu Log
- Logbee
- Magalu Entregas - Ultra Rápida
- Magalu Log - Ultra Rápida
- Logbee - Ultra Rápida
- Magalu Entregas - Agência Magalu
- Magalu Log - Agência Magalu
- Logbee - Agência Magalu

Detalhes da Requisição
Parâmetros
- Format: pdf ou zpl
- Orders: lista de pedidos
- DownloadInvoice: através deste campo você pode baixar a nf daquele pedido juntamente com a etiqueta


              curl -X 'POST' \
                'https://in.integracommerce.com.br/api/Order/ShippingLabels' \
                -H 'accept: */*' \
                -H 'Content-Type: application/json-patch+json' \
                -d '{
                "format": "pdf",
                "orders": [
                  "LU-12345"
                ],
                "downloadInvoice": true
              }'

OBS: Temos um processo de homologação específico para o Módulo de Etiquetas do Magalu Entregas. Para homologar sua aplicação com este módulo realize o seu cadastro no Acelera com Magalu, marcando a opção “Módulo de Etiquetas Magalu Entregas”

POST ConfirmReserves

Este recurso serve para fazer a liberação da reserva de estoque dos itens do pedido. Porém, indicamos que você utilize a OrderQueue (seguindo as instruções recomendadas neste material) para realizar o controle da reserva de estoque, se sua aplicação seguir as recomendações corretas de utilização da OrderQueue, o recurso ConfirmReserves não será necessário.


            curl -X 'POST' \
              'https://in.integracommerce.com.br/api/Order/ConfirmReserves' \
              -H 'accept: */*' \
              -H 'Content-Type: application/json-patch+json' \
              -d '[
              {
                "id": "2"
              }
            ]'

GET OrderPackage

Este recurso serve para recuperar pacotes específicos de um pedido

GET OrderPackage

Rota - (API Magalu Identity Provider) /api/OrderPackage/{IdPackage}

API Magalu Identity Provider
Homologação - https://api.integracommerce.com.br
Produção - https://in.integracommerce.com.br


            curl -X 'GET' \
              'https://in.integracommerce.com.br/api/OrderPackage/2314' \
              -H 'accept: */*'

ORDER QUEUE

Este recurso serve para recuperar pedidos novos, aprovados e cancelados no Magalu Marketplace. Conforme explicado acima, o Magalu Marketplace é totalmente passivo na integração, deste modo, não enviamos nenhum tipo de notificação para eventos de produtos ou de pedidos. Para todos os pedidos novos, aprovados e cancelados, fazemos uma postagem em uma fila interna, destinada a receber exclusivamente estes tipos de pedidos. A dinâmica de funcionamento desta fila está baseada em ler a fila de pedidos e, na sequência, realizar a atualização desta fila, evitando assim a captura de pedidos repetidos. Para realizar estas ações, disponibilizamos dois métodos, sendo eles o GET e o PUT.

GET OrderQueue

Rota - (API Magalu Identity Provider) /api/OrderQueue

API Magalu Identity Provider
Homologação - https://api.integracommerce.com.br
Produção - https://in.integracommerce.com.br

Detalhes da Requisição
Parâmetros
- Status: informe o status dos pedidos que você quer recuperar (NEW, APPROVED ou CANCELED)


            curl -X 'GET' \
              'https://in.integracommerce.com.br/api/OrderQueue?Status=NEW' \
              -H 'accept: */*'

PUT OrderQueue

Este recurso serve para fazer a atualização da fila de pedidos, liberando os pedidos processados. Utilize o ID do pacote recebido na requisição GET executada anteriormente para identificar o pacote que será liberado da fila.


            curl -X 'PUT' \
              'https://in.integracommerce.com.br/api/OrderQueue' \
              -H 'accept: */*' \
              -H 'Content-Type: application/json-patch+json' \
              -d '[
              {
                "id": 1
              }
            ]'

PUT Price

Este recurso serve para realizar a atualização de preços dos anúncios no Magalu Marketplace. Recomendamos que sempre utilize este método para realizar a atualização de preço, pois ele é mais performático para este tipo de ação. O recurso aceita até 100 itens por requisição.


            curl -X 'PUT' \
              'https://in.integracommerce.com.br/api/Price' \
              -H 'accept: */*' \
              -H 'Content-Type: application/json-patch+json' \
              -d '[
              {
                "idSku": "abc123",
                "listPrice": 10,
                "salePrice": 10
              }
            ]'