Criar/atualizar Pedido

POST

2022-05

orders

curl --request POST \
  --url https://api.reportana.com/2022-05/orders \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "reference_id": "<string>",
  "number": "<string>",
  "admin_url": "<string>",
  "customer_name": "<string>",
  "customer_phone": "<string>",
  "customer_email": "<string>",
  "customer_document": "<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": 123,
    "longitude": 123
  },
  "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>",
      "tracking_number": "<string>"
    }
  ],
  "currency": "<string>",
  "total_price": 123,
  "subtotal_price": 123,
  "payment_status": "<string>",
  "payment_method": "<string>",
  "tracking_numbers": "<string>",
  "referring_site": "<string>",
  "status_url": "<string>",
  "billet_url": "<string>",
  "billet_line": "<string>",
  "billet_expired_at": "<string>",
  "original_created_at": "<string>"
}'

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

Utilize este endpoint para criar ou atualizar um pedido em sua loja Reportana. O atributo reference_id é obrigatório e deve corresponder ao id ou à identificação única do pedido em seu sistema, garantindo a correta associação entre os dados de 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”.

number

string

required

Insira o número do pedido.

Exemplo: “1234”.

admin_url

string

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

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

customer_name

string

required

Insira o nome do cliente.

Exemplo: “João Moraes”.

customer_phone

string

required

Insira o telefone do cliente.

Exemplo: “+5511911111111”.

customer_email

string

required

Insira o e-mail do cliente.

Exemplo: “joaomoraes@gmail.com”.

customer_document

string

Insira o documento do cliente.

Exemplo: “099.999.999-99”.

Billing Adress

billing_address

object

required

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

number

Insira a latitude do cliente.

Exemplo: -27.807915923881836

longitude

number

Insira a longitude do cliente.

Exemplo: -50.3183162423294

Shipping Adress

shipping_address

object

required

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.

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[]

required

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 pedido.

Exemplo: 1

price

number

Insira o preço 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”.

tracking_number

string

Insira o número de rastreio do produto.

Exemplo: “LB123456789BR”.

Payment & More Info

currency

string

required

Insira a moeda utilizada.

Exemplo: “BRL”.

total_price

number

required

Insira o valor total.

Exemplo: 124.8

subtotal_price

number

required

Insira o valor subtotal.

Exemplo: 109.8

payment_status

string

Insira o status de pagamento.

Exemplo: “PAID”.

Opções disponíveis: PAID, PENDING, NOT_PAID.

payment_method

string

Insira o método de pagamento.

Exemplo: “PIX”.

Opções disponíveis: BOLETO, CREDIT_CARD, DEPOSIT, PIX, OTHER.

tracking_numbers

string

Insira os números de rastreio do pedido.

Exemplo: “LB123456789BR,LB987654321BR”.

referring_site

string

Insira a URL do site.

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

status_url

string

Insira a URL de status do pedido.

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

billet_url

string

Insira a URL de pagamento do pedido.

Exemplo: “https://example.com/orders/123456789/boleto.pdf”.

billet_line

string

Insira a linha digitável do boleto ou Pix Copia e Cola.

billet_expired_at

string

Insira a data de expiração do pagamento.

Exemplo: “2022-05-31”.

original_created_at

string

required

Insira a data de criação do pedido.

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

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

Autenticação Criar/atualizar Carrinho Abandonado

curl --request POST \
  --url https://api.reportana.com/2022-05/orders \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "reference_id": "<string>",
  "number": "<string>",
  "admin_url": "<string>",
  "customer_name": "<string>",
  "customer_phone": "<string>",
  "customer_email": "<string>",
  "customer_document": "<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": 123,
    "longitude": 123
  },
  "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>",
      "tracking_number": "<string>"
    }
  ],
  "currency": "<string>",
  "total_price": 123,
  "subtotal_price": 123,
  "payment_status": "<string>",
  "payment_method": "<string>",
  "tracking_numbers": "<string>",
  "referring_site": "<string>",
  "status_url": "<string>",
  "billet_url": "<string>",
  "billet_line": "<string>",
  "billet_expired_at": "<string>",
  "original_created_at": "<string>"
}'

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

Documentação API

Referência de API

Headers

Body

Billing Adress

Shipping Adress

Line Items

Payment & More Info

Documentação API

Referência de API

​Headers

​Body

​Billing Adress

​Shipping Adress

​Line Items

​Payment & More Info

Headers

Body

Billing Adress

Shipping Adress

Line Items

Payment & More Info