Criar um Carrinho

POST
https://api.eduzz.com/sun/v1/cart
Required scopes:sun_cart_write

O endpoint permite a criação de um carrinho de compras no checkout, onde vários itens são adicionados e interpretados como um único item, com seus valores somados e exibidos como um total consolidado.

Body params

orderIdRequired
string

ID do pedido

postbackUrlRequired
url

URL do webhook

returnUrl
url

URL para onde será redirecionado após o pagamento

installments
number

Número de parcelas

items
array of object
items[n].productIdRequired
string

ID do produto

items[n].descriptionRequired
string

Descrição do produto, ficará disponível para o usuário

items[n].price
object

Valor do produto, caso não seja informado será usado o valor configurado na criação do produto

items[n].price.value
number

Valor do produto

items[n].price.currency
enum

Moeda do valor do produto, atualmente só aceita o valor BRL

BRL
items[n].quantityRequired
number

Quantidade de produtos

customer
object

Informações do cliente

customer.email
string

Email do cliente

customer.name
string

Nome do cliente

customer.cellphone
string

Celular do cliente

customer.document
string

Documento do cliente

customer.address
object

Informações do endereço do cliente

customer.address.street
string

Rua do endereço do cliente

customer.address.number
string

Número do endereço do cliente

customer.address.neighborhood
string

Bairro do endereço do cliente

customer.address.complement
string

Complemento do endereço do cliente

customer.address.postalCode
string

Código postal do endereço do cliente

customer.address.state
string

Estado do endereço do cliente

Response params (201)

id
string

ID do pedido

key
string

Chave do pedido

orderId
string

ID do pedido

paymentUrl
url

URL para abertura do checkout

postbackUrl
url

URL do webhook

returnUrl
url

URL para onde será redirecionado após o pagamento

installments
number

Número de parcelas

items
array of object
items[n].productId
string

ID do produto

items[n].description
string

Descrição do produto, ficará disponível para o usuário

items[n].price
object

Valor do produto, caso não seja informado ou seja 0(zero) o produto será gratuito

items[n].price.value
number

Valor do produto

items[n].price.currency
enum

Moeda do valor do produto, atualmente só aceita o valor BRL

BRL
items[n].quantity
number

Quantidade de produtos

customer
object

Informações do cliente

customer.email
string

Email do cliente

customer.name
string

Nome do cliente

customer.cellphone
string

Celular do cliente

customer.document
string

Documento do cliente

customer.address
object

Informações do endereço do cliente

customer.address.street
string

Rua do endereço do cliente

customer.address.number
string

Número do endereço do cliente

customer.address.neighborhood
string

Bairro do endereço do cliente

customer.address.complement
string

Complemento do endereço do cliente

customer.address.postalCode
string

Código postal do endereço do cliente

customer.address.state
string

Estado do endereço do cliente

Status codes

StatusDescrição
201Success

Exemplos

1curl --request POST \
2	--url https://api.eduzz.com/sun/v1/cart \
3	--header 'accept: application/json' \
4	--header 'authorization: Bearer qzrUZcm4dISz/ayXgq7g9+GmusYbXHmIpJ7fbLYDIjUPtNwAN1rrsRZbeJ6e6tAlSUSy3w=='
Response
1{
2  "id": "12345",
3  "key": "00000000000000000000000000000000",
4  "orderId": "12345",
5  "paymentUrl": "https://sun.eduzz.com/c_00000000000000000000000000000000?contentId=12345",
6  "postbackUrl": "https://webhook.site/3559d85c-4c65-4035-854b-e935ef9c1278",
7  "returnUrl": "https://mysite.com/thanks-page",
8  "installments": 1,
9  "items": [
10    {
11      "productId": "123456",
12      "description": "My Product",
13      "price": {
14        "value": 1000,
15        "currency": "BRL"
16      },
17      "quantity": 1
18    }
19  ],
20  "customer": {
21    "email": "customer@eduzz.com",
22    "name": "Foo Bar",
23    "cellphone": "11988888888",
24    "document": "24246858005",
25    "address": {
26      "street": "Av. Sorocaba",
27      "number": "500",
28      "neighborhood": "Fantasia",
29      "complement": "AP 00",
30      "postalCode": "18044390",
31      "state": "SP"
32    }
33  }
34}