POST
/
2022-05
/
abandoned-checkouts
curl --request POST \
  --url https://api.reportana.com/2022-05/abandoned-checkouts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "reference_id": "<string>",
  "reason_type": "<string>",
  "number": "<string>",
  "admin_url": "<string>",
  "customer_name": "<string>",
  "customer_email": "<string>",
  "customer_phone": "<string>",
  "billing_address": {
    "name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "company": "<string>",
    "phone": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "province": "<string>",
    "province_code": "<string>",
    "country": "<string>",
    "country_code": "<string>",
    "zip": "<string>",
    "latitude": "<string>",
    "longitude": "<string>"
  },
  "shipping_address": {
    "name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "company": "<string>",
    "phone": "<string>",
    "address1": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "province": "<string>",
    "province_code": "<string>",
    "country": "<string>",
    "country_code": "<string>",
    "zip": "<string>",
    "latitude": "<string>",
    "longitude": "<string>"
  },
  "line_items": [
    {
      "title": "<string>",
      "variant_title": "<string>",
      "quantity": 123,
      "price": 123,
      "path": "<string>",
      "image_url": "<string>"
    }
  ],
  "currency": "<string>",
  "total_price": 123,
  "subtotal_price": 123,
  "referring_site": "<string>",
  "checkout_url": "<string>",
  "completed_at": "<string>",
  "original_created_at": "<string>"
}'
{
  "success": true,
  "data": null
}

Utilize este endpoint para criar ou atualizar um carrinho abandonado em sua loja Reportana. O atributo reference_id é obrigatório e deve corresponder ao id ou à identificação exclusiva do carrinho abandonado em seu sistema, garantindo a sincronização correta entre os dados do seu sistema e nossa plataforma.

Headers

Authorization
string
required

Basic base64(client_id + ’:’ + client_secret)

Content-Type
string
required

Content-Type:application/json

Body

reference_id
string
required

Insira o ID de referência.

Exemplo: “123456789”.

reason_type
string
required

Insira o motivo do carrinho abandonado.

Exemplo: null

Opções disponíveis: DECLINED_CREDIT_CARD, null.

number
string
required

Insira o número do carrinho abandonado.

Exemplo: “1234”.

admin_url
string

Insira a URL de acesso do carrinho abandonado no painel de administração.

Exemplo: “https://example.com/admin/carts/123456789”.

customer_name
string
required

Insira o nome do cliente.

Exemplo: “João Moraes”.

customer_email
string
required

Insira o e-mail do cliente.

Exemplo: “joaomoraes@gmail.com”.

customer_phone
string
required

Insira o telefone do cliente.

Exemplo: “+5511911111111”.

Billing Adress

billing_address
object

Insira as informações de endereço de cobrança.

name
string

Insira o nome do cliente.

Exemplo: João Moraes”.

first_name
string

Insira o primeiro nome do cliente.

Exemplo: “João”.

last_name
string

Insira o sobrenome do cliente.

Exemplo: “Moraes”.

company
string

Insira o nome da empresa.

Exemplo: “João Moraes Ltda”.

phone
string

Insira o telefone do cliente.

Exemplo: “+5511911111111”.

address1
string

Insira o endereço do cliente.

Exemplo: “Av Belisário Ramos, 3735”.

address2
string

Insira o bairro do cliente.

Exemplo: “Sagrado Coração Jesus”.

city
string

Insira a cidade do cliente.

Exemplo: “Lages”.

province
string

Insira o estado do cliente.

Exemplo: “Santa Catarina”.

province_code
string

Insira o código do estado do cliente.

Exemplo: “SC”.

country
string

Insira o país do cliente.

Exemplo: “Brazil”.

country_code
string

Insira o código do país do cliente.

Exemplo: “BR”.

zip
string

Insira o CEP do cliente.

Exemplo: “88508100”.

latitude
string

Insira a latitude do cliente.

Exemplo: -50.3183162423294

longitude
string

Insira a longitude do cliente.

Exemplo: -27.807915923881836

Shipping Adress

shipping_address
object

Insira as informações de endereço de entrega.

name
string

Insira o nome do cliente.

Exemplo: João Moraes”.

first_name
string

Insira o primeiro nome do cliente.

Exemplo: “João”.

last_name
string

Insira o sobrenome do cliente.

Exemplo: “Moraes”.

company
string

Insira o nome da empresa.

Exemplo: “João Moraes Ltda”.

phone
string

Insira o telefone do cliente.

Exemplo: “+5511911111111”.

address1
string

Insira o endereço do cliente.

Exemplo: “Av Belisário Ramos, 3735”.

address2
string

Insira o bairro do cliente.

Exemplo: “Sagrado Coração Jesus”.

city
string

Insira a cidade do cliente.

Exemplo: “Lages”.

province
string

Insira o estado do cliente.

Exemplo: “Santa Catarina”.

province_code
string

Insira o código do estado do cliente.

Exemplo: “SC”.

country
string

Insira o país do cliente.

Exemplo: “Brazil”.

country_code
string

Insira o código do país do cliente.

Exemplo: “BR”.

zip
string

Insira o CEP do cliente.

Exemplo: “88508100”.

latitude
string

Insira a latitude do cliente.

Exemplo: -27.807915923881836

longitude
string

Insira a longitude do cliente.

Exemplo: -50.3183162423294

Line Items

line_items
object[]

Clique em “Add an item” para adicionar um produto.

title
string

Insira o título do produto.

Exemplo: “Óculos”.

variant_title
string

Insira o título da variante do produto.

Exemplo: “Preto”.

quantity
number

Insira a quantidade de produtos no carrinho abandonado.

Exemplo: 1

price
number

Insira o valor do produto.

Exemplo: 49.9

path
string

Insira a URL de acesso público do produto.

Exemplo: “https://example.com/products/1234”.

image_url
string

Insira a URL da imagem do produto.

Exemplo: “https://example.com/products/1234/image.jpg”.

Checkout & More Info

currency
string
required

Insira a moeda do carrinho abandonado.

Exemplo: “BRL”.

total_price
number
required

Insira o valor total do carrinho abandonado.

Exemplo: 124.8

subtotal_price
number
required

Insira o valor subtotal do carrinho abandonado.

Exemplo: 109.8

referring_site
string

Insira a URL do seu site.

Exemplo: “https://www.facebook.com/”.

checkout_url
string

Insira a URL para o link de checkout.

Exemplo: “https://example.com/carts/123456789”.

completed_at
string

Insira a data em que o carrinho foi completado.

Exemplo: “2022-05-31 23:59”.

original_created_at
string
required

Insira a data de criação do carrinho abandonado.

Exemplo: “2022-05-27 12:00”.

{
  "success": true,
  "data": null
}