Passar para o conteúdo principal

API Adstart

Adicione plataformas de e-commerces customizadas com a API da Adstart

Weslem - Adstart Suporte avatar
Escrito por Weslem - Adstart Suporte
Atualizado há mais de 3 meses

O que é essa API?

A API da Adstart é uma interface RESTful desenvolvida para permitir a integração entre plataformas de e-commerce e o ecossistema de análise, automação e marketing da Adstart. Com ela, é possível enviar pedidos, atualizar informações em tempo real e registrar dados de carrinhos abandonados, tudo com segurança e precisão.

🔐 Autenticação

Todos os requests devem ser autenticados por meio de headers HTTP com um token de acesso.

Exemplo de Hearders

{
  "Authorization": "Bearer {token}",
  "Content-Type": "application/json"
}

🌐 Base URL

https://api.adstart.com.br

📦 Criar Pedido

Endpoint:

POST /ecommerces/orders

Descrição:
Cria um novo pedido no sistema.

📝 Campos da Requisição:

Campo

Tipo

Descrição

platformOrderId

string

Identificador único do pedido na plataforma de origem

platformStatus

string ou null

Status do pedido na plataforma

orderTime

date

Data e hora de criação do pedido

status

enum

Status atual do pedido

paymentMethod

enum

Método de pagamento utilizado

orderOrigin

enum

Origem do pedido

orderSourceOrigin

string ou null

Nome da fonte de origem

invoicedDate

date ou null

Data de faturamento

deliveryDate

date ou null

Data de entrega

paymentDate

date ou null

Data de pagamento confirmado

returnedDate

date ou null

Data de devolução

deliveryEstimateDate

date ou null

Previsão de entrega

currency

string ou null

Moeda (ex: BRL, USD)

couponCode

string ou null

Código de desconto

installments

number ou null

Parcelas

invoiceKeys

array de string

Chaves das notas fiscais

cancelReason

string ou null

Motivo do cancelamento

orderTotalValue

number

Valor total com frete e descontos

paidShippingValue

number ou null

Frete pago

orderShippingValue

number

Valor do frete

orderProductsValue

number

Valor dos produtos

orderDiscountAmount

number

Total de descontos

quantityOfItemsSold

number ou null

Itens vendidos

shippingLabel

string ou null

Etiqueta de envio

shippingIntegratorName

string ou null

Nome do integrador (Correios, etc.)

paymentProcessor

string ou null

Processador de pagamento

paymentMethodName

string ou null

Nome do método (Visa, etc.)

sessionId

string ou null

ID da sessão do cliente

landingUrl

string ou null

URL da landing page

referringUrl

string ou null

URL de referência

marketplaceName

string ou null

Nome do marketplace

browserIp

string ou null

IP do cliente

userAgent

string ou null

User Agent

userAgentBrowserName

string ou null

Navegador usado

userAgentDeviceType

string ou null

Tipo de dispositivo

userAgentDeviceModel

string ou null

Modelo do dispositivo

userAgentDeviceVendor

string ou null

Fabricante

userAgentOsName

string ou null

Sistema operacional

userAgentOsVersion

string ou null

Versão do sistema

userId

string ou null

ID do cliente

userName

string ou null

Nome do cliente

userEmail

string ou null

Email do cliente

userBirthday

date ou null

Data de nascimento

userPhone

string ou null

Telefone

userGender

enum

Gênero

userDocumentType

string ou null

Tipo de documento

userDocument

string ou null

Número do documento

zipCode, street, addressNumber, neighborhood, complement, city, addressState, country

string ou null

Endereço de entrega

invoiceLink

string ou null

Link da nota fiscal

trackingLink

string ou null

Link de rastreamento

paymentLink

string ou null

Link do pagamento

📦 Produtos do Pedido (products[])

  • productName: string

  • skuName: string ou null

  • quantity: number

  • unitPrice: number

  • discountValue: number

  • paidPrice: number

  • platformSkuId: string

  • platformProductId: string

📘 Enums Permitidos:

status:

  • PAYMENT_PENDING

  • PAYMENT_APPROVED

  • INVOICED

  • DELIVERED

  • CANCELED

  • RETURNED

  • PARTIALLY_RETURNED

paymentMethod:

  • CREDIT_CARD

  • DEBIT_CARD

  • PIX

  • BOLETO

  • OTHERS

orderOrigin:

  • OTHER

  • ECOMMERCE

  • MARKETPLACE

  • POINT_OF_SALE

userGender:

  • MALE

  • FEMALE

  • OTHER

  • UNKNOWN

🔄 Atualizar Pedido

Endpoint:PUT /ecommerces/orders/{platformOrderId}

📝 Campos da Requisição:

Campos opcionais para atualização:

  • status

  • platformStatus

  • invoiceLink

  • trackingLink

  • paymentLink

  • orderSourceOrigin

  • orderOrigin

  • orderTotalValue

📘 Enums Permitidos:

Mesmos de Criar Pedido.

🛒 Criar Carrinho

Endpoint:POST /ecommerces/carts

📝 Campos da Requisição:

Campo

Tipo

Descrição

platformCartId

string

ID do carrinho

customerName

string

Nome do cliente

customerPhone

string

Telefone

itemsCount

number

Quantidade de itens

value

number

Valor total

cartLink

string ou null

Link para acessar o carrinho

status

enum

Status do carrinho

items[]

array de objetos

Lista de produtos (opcional)

🛍 Campos do Produto (items[]):

  • name: string ou null

  • price: number ou null

  • quantity: number ou null

  • platformProductId: string ou null

  • imageUrl: string ou null

📘 Enums:

status:

  • open

  • closed

✅ Códigos de Status HTTP

Código

Significado

200

Requisição bem-sucedida

201

Recurso criado com sucesso

400

Requisição inválida

401

Não autorizado

403

Acesso proibido

404

Recurso não encontrado

500

Erro interno do servidor

Respondeu à sua pergunta?