Ir para o conteúdo

Preço

Um preço representa um valor de venda do produto. Contém informações básicas e essenciais, incluido o SKU, valor, moeda, normalizador e canal de publicação.

Criar um novo preço

Cria um novo preço para a venda desse produto em um canal de publicação.

Alerta

Para atualizar, basta criar um novo preço para que o mesmo seja atualizado.

Escopo requerido

Valor Descrição
open:portfolio:write Permite gerenciar os preços

Parâmetros da chamada

Propriedade Tipo Descrição Obrigatório
type string Identifica o tipo do preço do SKU especificado. Valores permitidos list e sell Sim
sku string O SKU exclusivo do item Sim
value int Valor do SKU, desnormalizado em relação ao código da moeda Sim
currency string Código da moeda, de acordo à ISO-4217 Sim
normalizer int Valor normalizador de value para unidade de currency. Valor padrão 100. Para maiores informações consulte Sim
extras object Informações adicionais sobre o preço. Quando não houver um valor você poderá enviar {}. Sim
channel object Canal para publicação do preço 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

Chamada:

curl -X 'POST' \
  'https://api.magalu.com/v0/portfolios/prices' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "type": "list",
  "value": 5990,
  "currency": "BRL",
  "normalizer": 100,
  "sku": "abc",
  "extras": {},
  "channel": {
    "id": "1aba5746-1d52-48a1-a7a7-c1307db5e262",
    "extras": {}
  }
}'

Resposta:

{
  "id": "f00ffabc-5af5-47a8-9626-31d0359c87e2",
  "type": "list",
  "value": 5990,
  "currency": "BRL",
  "normalizer": 100,
  "sku": "abc",
  "extras": {},
  "channel": {
    "id": "1aba5746-1d52-48a1-a7a7-c1307db5e262",
    "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
409 Conflict
403 Forbidden
422 Unprocessable Entity
500 Internal Server Error
502 Bad Gateway
503 Service Unavailable
504 Gateway Timeout

Recuperar uma lista de preços

Retorna todos os registros de preços 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 preços

Parâmetros de consulta

Campo Tipo Descrição Obrigatório
sku string Retorna os preços do SKU especificado Não
type string Retorna os tipos de preços do SKU especificado. Valores permitidos list e sell Não
channel.id__in array Retornar os preços dos canais especificados Não

Parâmetros de ordenação

Campo Descrição Obrigatório
created_at Ordernar por data de criação dos preços. Não

Chamada:

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

Resposta:

{
  "meta": {
    ...
  },
  "results": [
    {
      "id": "f00ffabc-5af5-47a8-9626-31d0359c87e2",
      "type": "list",
      "value": 5990,
      "currency": "BRL",
      "normalizer": 100,
      "sku": "abc",
      "extras": {},
      "channel": {
        "id": "1aba5746-1d52-48a1-a7a7-c1307db5e262",
        "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 um preço

Retorna um preço específico.

Escopo requerido

Valor Descrição
open:portfolio:read Permite acessar um preço específico

Parâmetros da URL

Campo Tipo Descrição Obrigatório
id uuid Identificação do preço Sim

Chamada:

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

Resposta:

{
  "type": "list",
  "value": 5990,
  "currency": "BRL",
  "normalizer": 100,
  "sku": "abc",
  "extras": {},
  "channel": {
    "id": "1aba5746-1d52-48a1-a7a7-c1307db5e262",
    "extras": {}
  },
  "id": "f00ffabc-5af5-47a8-9626-31d0359c87e2",
  "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