Conjuntos de dados

Esta rota devolve o esquema versão 1 dos conjuntos que um job pode exportar. O catálogo é fechado: são exatamente estes seis, e as colunas só mudam com uma nova versão do esquema (v2 no caminho dos arquivos). Use-o para criar as tabelas no seu data warehouse antes da primeira carga.

Consultar o catálogo

Exemplo de requisição

curl "$BASE_URL/api/v1/admin/warehouse/datasets" \
  -H "Authorization: Bearer $TOKEN"

Resposta

[
  {
    "dataset": "customers",
    "version": "v1",
    "columns": [
      {
        "name": "id",
        "type": "string"
      },
      {
        "name": "email",
        "type": "string"
      },
      {
        "name": "created_at",
        "type": "timestamp_micros"
      },
      {
        "name": "updated_at",
        "type": "timestamp_micros"
      },
      {
        "name": "deleted_at",
        "type": "timestamp_micros"
      }
    ]
  }
]

A resposta real traz os seis conjuntos; o exemplo mostra um, encurtado. É um vetor JSON direto.

Colunas de cada conjunto

orders: id (string), order_number (string), customer_id (string), status (string), status_label (string), payment_status (string), subtotal_cents (bigint_cents), shipping_total_cents (bigint_cents), tax_total_cents (bigint_cents), discount_total_cents (bigint_cents), total_cents (bigint_cents), created_at (timestamp_micros), updated_at (timestamp_micros), deleted_at (timestamp_micros)

order_items: id (string), order_id (string), product_id (string), product_name (string), unit_price_cents (bigint_cents), quantity (int64), discount_cents (bigint_cents), tax_cents (bigint_cents), total_cents (bigint_cents), created_at (timestamp_micros)

customers: id (string), email (string), created_at (timestamp_micros), updated_at (timestamp_micros), deleted_at (timestamp_micros)

products: id (string), name (string), sku (string), price_cents (bigint_cents), quantity (int64), created_at (timestamp_micros), updated_at (timestamp_micros), deleted_at (timestamp_micros)

inventory: product_id (string), sku (string), quantity (int64), track_inventory (boolean), low_stock_alert (int64), updated_at (timestamp_micros), deleted_at (timestamp_micros)

commissions: id (string), order_id (string), vendor_id (string), item_amount_cents (bigint_cents), commission_amount_cents (bigint_cents), vendor_amount_cents (bigint_cents), created_at (timestamp_micros)

A coluna de marca d'água de cada conjunto é updated_at em orders, customers, products e inventory, e created_at em order_items e commissions (que não são alterados depois de criados). Em orders, status é a letra do status e status_label o nome por extenso em inglês (pending, processing, paid, shipped, completed, cancelled, refunded, failed, declined, chargeback).

Erros

Veja também

• Jobs
• Destinos