Referência da API · Carrinho Personalizado
Criar Carrinho Personalizado
- Método
- POST
- Rota
-
/customCart/create - URL base
https://ws.autorei.net- Token
- Exige token Bearer
Abre esta requisição na documentação pública da API, a fonte oficial da referência.
Descrição
Cria um carrinho com produtos pré-selecionados para um cliente e devolve o link de acesso ao carrinho, para você enviar ao cliente. O cliente abre o link e finaliza a compra com os itens já montados.
Corpo da Requisição (JSON)
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cartName |
string | Sim | Nome do carrinho, para você identificá-lo depois. |
document |
string | Sim | CPF ou CNPJ do cliente. O cliente precisa existir na sua loja. |
products |
array | Sim | Itens do carrinho. |
sellerEmail |
string | Não | E-mail do vendedor responsável pelo carrinho. |
cartTypeName |
string | Não | Nome do tipo de carrinho. |
cartTypeExternalId |
string | Não | Id externo do tipo de carrinho, no seu sistema. |
metadata |
array | Não | Pares de dados livres para você anexar ao carrinho. |
metadata[].key · metadata[].value · metadata[].type |
string | - | Chave, valor e tipo do dado. |
Dentro de cada item de products:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
stockId |
integer | Sim | Id do estoque do produto na sua loja. É a identificação aceita pelo carrinho. |
quantity |
integer | Sim | Quantidade do produto. |
virtualQuantity |
integer | Não | Quantidade em estoque virtual. |
warehouse |
integer | Não | Id do depósito de origem do item. |
storeExternalId |
string | Não | Id externo da loja do item. |
skuId |
integer | Não | Id do SKU. |
partnerPartCode |
string | Não | Seu código de produto. |
key |
string | Não | Chave própria do item. |
Regras de negócio
O link do carrinho vem no campo message
A resposta não tem um campo próprio para a URL: o link chega em message. O trecho final do link é a chave do carrinho, é ela que aparece nas consultas como access_hash.
Resposta · 200
| Campo | Tipo | Descrição |
|---|---|---|
status |
string | ok no sucesso. |
message |
string | URL do carrinho para enviar ao cliente. |
cartId |
integer | Id do carrinho. Use-o para alterar ou excluir. |
Erros
| Código | Quando |
|---|---|
| 400 | O carrinho não foi criado. A mensagem vem do serviço de carrinho, por exemplo account not found quando o documento não corresponde a um cliente da sua loja, ou stockId incorreto quando o item não é da sua loja. |
| 401 | Token ausente, malformado ou expirado. |
Exemplo de requisição
curl --request POST 'https://ws.autorei.net/customCart/create' \
--header 'Authorization: Bearer {{access_token}}' \
--header 'Content-Type: application/json' \
--data '{
"cartName": "Proposta Ana Paula - setembro",
"document": "700.413.648-56",
"sellerEmail": "integracao@lojaexemplo.com.br",
"products": [
{
"stockId": 4410001,
"quantity": 2
},
{
"stockId": 4410002,
"quantity": 1
}
]
}' Respostas de exemplo
200Sucesso: carrinho criado
{
"status": "ok",
"message": "https://lojaexemplo.cws.digital/carrinho-personalizado/k7m2p9x4t1c6b8v3n5q0w7z2y4d6f8h1",
"cartId": 4470001
} Usado em
- Casos de usoPortal B2B próprio: o caminho típico pela API
- Casos de usoCompras B2B e suprimentos: o caminho típico pela API
- Casos de usoVenda assistida e balcão: o caminho típico pela API
Endpoints relacionados
Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.