Autenticação

Seja mais sobre a autenticação em Documentação API Autenticação

Criação do Carrinho

Para utilização da Webhook de criação do carrinho será necessário fazer uma requisição POST para a seguinte url:

POST <https://api.newtail.com.br/webhook/shopping-cart>

No body da requisição do webhook, deve-se mandar:

  • Identificação da loja
  • Identificação do cliente
  • Lista de itens

Exemplo:

{
  "store_id": "123",
  "products_message": "1 arroz namorado\\n4 laranjas\\n1 farinha trigo veneranda\\n8 coca cola 2l\\nbombom amor carioca",
  "items": [
    {
      "external_id": "id da oferta",
      "quantity": 999.99
    }
  ],
  "shipping_type": "pick_up_in_store|shipping_from_store",
  "address": {
    "address_street": "Avenida Paulista",
    "address_number": "123",
    "address_neighborhood": "bairro",
    "address_postal_code": "01310915",
    "address_complement": "bloco 2",
    "address_city": "São Paulo",
    "address_state": "SP",
    "address_country": "Brasil",
  },
  "customer": {
    "name": "João",
    "document": {
      "social_id": "12345678910",
      "type": "cpf"
    },
    "date_of_birth": "2000-01-01",
    "main_phone": "5521999999999",
    "main_email": "string"
  }
}

Obs:

  • Os seguintes campos do cliente são obrigatórios: name, document e main_phone.
  • A lista de itens deve ser um texto com os produtos separados por **\\n**
  • Os atributos products_message ou items são condicionais. devem ser enviados. um ou outro. caso sejam enviados os dois. apenas o campo items será considerado.
  • pick_up_in_store retirada na loja; shipping_from_store entrega em domicilio. Se o tipo for shipping_from_store então o endereço de entrega é obrigatório.

O retorno da requisição terá código HTTP 201 quando o carrinho for criado com sucesso. Em caso de erro será enviado um HTTP 5XX, com o possível problema.

{
  "cart_id": "8aeea7ce-e92c-416a-b73c-0caf741c3b42",
  "cart_url": "<https://cart.newtail.com.br/cart_id>", // esse campo é opcional.
  "sla": 1440 // em minutos. esse campo é opcional,
  "sla_date": "iso8601", // data em formato iso 8601 compatível com o sla em UTC. presente somente quando o sla estiver disponível
}

Se o campo cart_url não estiver presente na resposta, o link não deve ser enviado automaticamente para o cliente, pois o carrinho passará por uma revisão manual antes de ser disponibilizado.