Nuvemshop

Checkouts abandonados

GET
/v1/nuvemshop/abandoned-checkouts

Uma linha por checkout que o comprador começou e não concluiu: itens, totais, cupons e opção de frete.

dateFrom e dateTo filtram por created_at (dias inclusivos, YYYY-MM-DD). As linhas são ordenadas por id, integration_id, inserted_at e paginadas com page/limit; meta.hasNextPage diz se existe outra página. As respostas ficam em cache por 30 minutos.

Autorização

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Parâmetros de query

organizationId*string

Organização dona das contas conectadas.

Formatouuid
integrationId?string

Uma conta conectada desta integração (o integration_id das linhas). Omita para ler todas as contas da organização.

Tamanholength <= 255
dateFrom?string

Primeiro dia (inclusivo) de created_at, YYYY-MM-DD.

Formatodate
dateTo?string

Último dia (inclusivo) de created_at, YYYY-MM-DD. Não pode ser anterior a dateFrom.

Formatodate
page?integer

Número da página, a partir de 1.

Intervalo1 <= value <= 1000000
Padrão1
limit?integer

Linhas por página (máximo 5000).

Intervalo1 <= value <= 5000
Padrão500

Corpo da resposta

Uma página de linhas

application/json
  1. response
data*array<>
meta*
curl -X GET "https://example.com/v1/nuvemshop/abandoned-checkouts?organizationId=3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b&dateFrom=2026-10-01&dateTo=2026-10-31"
{  "data": [    {      "id": "123456",      "created_at": "2026-10-01T12:00:00.000Z",      "updated_at": "2026-10-01T12:00:00.000Z",      "completed_at": "2026-10-01T12:00:00.000Z",      "currency": "example",      "language": "example",      "subtotal": "125.50",      "discount": "125.50",      "discount_coupon": "125.50",      "discount_gateway": "125.50",      "total": "125.50",      "shipping_cost_customer": "125.50",      "shipping_option": "example",      "coupon_codes": "example",      "item_count": 10,      "quantity_total": "125.50",      "items": "example",      "customer_id": "123456",      "contact_email": "name@example.com",      "region": "example",      "storefront": "example",      "store_key": "example",      "store_domain": "example",      "integration_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",      "organization_id": "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b",      "organization_id_legacy": "example",      "user_id": "123456",      "document_id": "123456",      "inserted_at": "2026-10-01T12:00:00.000Z",      "integration_name": "example"    }  ],  "meta": {    "page": 1,    "limit": 500,    "hasNextPage": false,    "hasPreviousPage": false  }}