Ir para o conteúdo

Registro

Criar um registro

Serviço de criação de tópicos e subscriptions com webhook informado, para integrar um seller, quando um integrador for utilizar nossos serviços.

Parâmetros da chamada

Campo Tipo Descrição Obrigatório
webhook URL URL do webhook que receberá as notificações Sim
topic_id str Identificação do tópico Não
filter_by object Permite filtrar as mensagens enviadas para o webhook de acordo com o conteúdo do evento. Para utilizar esse campo, o topic_id deverá ser informado. Não

Chamada:

curl -X 'PUT' \
  'https://api.magalu.com/v0/onboarding/signup' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer <Access Token>' \
  -H 'Content-Type: application/json' \ \
  -d '{
    "webhook": "https://sua.url.webhook/",
    "topic_id": "create_sku",
    "filter_by": {
      "and": [
        {
          "eq": [
            "store",
            "example_corp"
          ]
        },
        {
          "neq": [
            "event",
            "order_cancelled"
          ]
        },
        {
          "in": [
            "customer_interests",
            [
              "rugby",
              "football",
              "baseball"
            ]
          ]
        },
        {
          "or": [
            {
              "gte": [
                "price_usd",
                100
              ]
            },
            {
              "lte": [
                "price_usd",
                0
              ]
            }
          ]
        }
      ]
    }  
  }'

Resposta:

{
  "create": "OK",
  "webhook": "OK",
}

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
422 Unprocessable Entity
500 Internal Server Error
502 Bad Gateway
503 Service Unavailable
504 Gateway Timeout