Inventário

Um inventário representa um bem físico, isto é, a quantidade de produtos disponíveis para a venda. Ele contém informações básicas e essenciais, incluindo apenas o SKU, quantidade disponível, unidade de medida e canal de publicação.

Criar uma posição no inventário

Informar a quantidade de produtos disponíveis para a venda em um canal de publicação.

Alerta

Para atualizar, basta criar uma nova posição no inventário para que o mesmo seja atualizado.

Escopo requerido

Valor	Descrição
open:portfolio:write	Permite gerenciar um inventário

Parâmetros da chamada

Propriedade	Tipo	Descrição	Obrigatório
sku	string	O SKU exclusivo do item	Sim
channel	object	Canal para publicação do inventário	Sim
channel.id	uuid	Identificação do canal, para visualizar a lista de canais, consulte aqui	Sim
channel.extras	object	Informações adicionais sobre o canal. Quando não houver um valor você poderá enviar {}.	Sim
quantity	decimal	Quantidade do item	Sim
unit	string	Unidade de médida	Sim
extras	object	Informações adicionais sobre o inventário. Quando não houver um valor você poderá enviar {}.	Sim

Chamada:

curl -X 'POST' \
  'https://api.magalu.com/v0/portfolios/inventories' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "sku": "ABC1232fd",
  "channel": {
    "id": "1aba5746-1d52-48a1-a7a7-c1307db5e262",
    "extras": {}
  },
  "quantity": 1.5,
  "unit": "unit",
  "extras": {}
}'

Resposta:

{
  "id": "feb7dac8-bdf0-43c4-acc3-a40336c7f88e",
  "sku": "ABC1232fd",
  "channel": {
    "id": "1aba5746-1d52-48a1-a7a7-c1307db5e262",
    "extras": {}
  },
  "quantity": 1.5,
  "unit": "unit",
  "extras": {},
  "created_at": "2022-06-15T14:25:37Z"
}

Códigos de retorno

Nota

Para maiores informações sobre códigos de retorno, Código de retorno.

Código	Descrição
201	Created
401	Unauthorized
403	Forbidden
409	Conflict
422	Unprocessable Entity
500	Internal Server Error
502	Bad Gateway
503	Service Unavailable
504	Gateway Timeout

Recuperar uma lista de inventários

Retorna todos os registros de inventário disponíveis.

Nota

Este endpoint implementa paginação, ordenação e filtros. Para saber mais, consulte Fazer solicitações paginadas e parâmetros de consulta.

Escopo requerido

Valor	Descrição
open:portfolio:read	Permite listar os inventários

Parâmetros de consulta

Campo	Tipo	Descrição	Obrigatório
sku	string	Retorna os inventários do SKU especificado	Não
channel.id__in	array	Retornar os inventários dos canais especificados	Não

Parâmetros de ordenação

Campo	Descrição	Obrigatório
created_at	Ordernar por data de criação dos inventários.	Não

Chamada:

curl -X 'GET' \
  'https://api.magalu.com/v0/portfolios/inventories' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

{
  "meta": {
    ...
  },
  "results": [
    {
      "id": "feb7dac8-bdf0-43c4-acc3-a40336c7f88e",
      "sku": "ABC1232fd",
      "channel": {
        "id": "1aba5746-1d52-48a1-a7a7-c1307db5e262",
        "extras": {}
      },
      "quantity": 1.5,
      "unit": "unit",
      "extras": {},
      "created_at": "2022-06-15T14:25:37Z"
    }
  ]
}

Códigos de retorno

Nota

Para maiores informações sobre códigos de retorno, Código de retorno.

Código	Descrição
200	Ok
400	Bad Request
401	Unauthorized
403	Forbidden
422	Unprocessable Entity
500	Internal Server Error
502	Bad Gateway
503	Service Unavailable
504	Gateway Timeout

Recuperar uma posição no inventário

Retorna uma posição do inventário em específica.

Escopo requerido

Valor	Descrição
open:portfolio:read	Permite acessar uma posição do inventário

Parâmetros da URL

Campo	Tipo	Descrição	Obrigatório
id	uuid	Identificação da posição no inventário	Sim

Chamada:

curl -X 'GET' \
  'https://api.magalu.com/v0/portfolios/inventories/{id}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \

Resposta:

{
  "id": "feb7dac8-bdf0-43c4-acc3-a40336c7f88e",
  "sku": "ABC1232fd",
  "channel": {
    "id": "1aba5746-1d52-48a1-a7a7-c1307db5e262",
    "extras": {}
  },
  "quantity": 1.5,
  "unit": "unit",
  "extras": {},
  "created_at": "2022-06-15T14:25:37Z"
}

Códigos de retorno

Nota

Para maiores informações sobre códigos de retorno, Código de retorno.

Código	Descrição
200	OK
401	Unauthorized
403	Forbidden
404	Not Found
422	Unprocessable Entity
500	Internal Server Error
502	Bad Gateway
503	Service Unavailable
504	Gateway Timeout