WooCommerce

Pedidos

GET
/v1/woocommerce/orders

Uma linha por pedido: status, totais, descontos, impostos, frete, pagamento, cupons e atribuição de UTM.

dateFrom e dateTo filtram por date_created_gmt (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 date_created_gmt, YYYY-MM-DD.

Formatodate
dateTo?string

Último dia (inclusivo) de date_created_gmt, 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/woocommerce/orders?organizationId=3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b&dateFrom=2026-10-01&dateTo=2026-10-31"
{  "data": [    {      "id": "123456",      "number": "example",      "status": "example",      "currency": "example",      "prices_include_tax": true,      "created_via": "example",      "customer_id": "123456",      "is_guest": true,      "customer_email": "name@example.com",      "billing_region": "example",      "payment_method": "example",      "payment_method_title": "example",      "date_created_gmt": "2026-10-01T12:00:00.000Z",      "date_modified_gmt": "2026-10-01T12:00:00.000Z",      "date_paid_gmt": "2026-10-01T12:00:00.000Z",      "date_completed_gmt": "2026-10-01T12:00:00.000Z",      "discount_total": "125.50",      "discount_tax": "125.50",      "shipping_total": "125.50",      "shipping_tax": "125.50",      "total": "125.50",      "total_tax": "125.50",      "cost_total": "125.50",      "shipping_method_id": "123456",      "shipping_method_title": "example",      "shipping_lines_count": 10,      "coupon_codes": "example",      "coupon_discount_total": "125.50",      "refund_count": 10,      "attribution_source_type": "example",      "utm_source": "example",      "utm_medium": "example",      "utm_campaign": "example",      "utm_content": "example",      "utm_term": "example",      "utm_id": "123456",      "attribution_session_entry": "example",      "attribution_referrer": "example",      "attribution_device_type": "example",      "attribution_session_start_time": "example",      "attribution_session_pages": 10,      "attribution_session_count": 10,      "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  }}