KOkobana
Importações

Listar Importações

Lista as importações realizadas para um tipo específico de recurso (clientes, assinaturas, boletos ou carnês).

get/v1/imports/{collection_name}

Request

Path parameters

collection_name'customers' | 'customer_subscriptions' | 'bank_billets' | 'installments' required

Tipo da importação:

  • customers Clientes
  • customer_subscriptions Assinaturas
  • bank_billets Boletos
  • installments Carnês

Query parameters

pageinteger

Número da Página

per_pageinteger

Quantidade de registros por página

Headers

User-Agentstring

Informar um e-mail válido para contatos.

Response

Importações encontradas

idinteger

ID da Importação.

statusstring

Status da importação.

enqueued: Aguardando processamento. [Estado inicial] failed: Processamento não realizado devido a erro. processed: Processamento concluído.

started_atstring date-time nullable

Data/hora de início do processamento da Importação

finished_atstring date-time nullable

Data/hora de fim do processamento da Importação

created_atstring date-time

Data/hora da criação da Importação

updated_atstring date-time

Data/hora da atualização da Importação

created_rowsinteger
enqueued_atstring date-time nullable
processed_atstring date-time nullable
failed_to_create_rowsinteger
failed_to_update_rowsinteger
import_errorsobject nullable
processed_rowsinteger
total_rowsinteger nullable
updated_rowsinteger

Changes

No recorded changes to this operation across all 1 revision of this API.