Orders by payment outcome and payment method
Orders CREATED in the period (creation day in UTC), one row per payment method chosen at checkout, each order in exactly one outcome: paid (the payment was approved, even if the order was canceled afterwards), canceled (canceled without a payment: refused, or expired and canceled by the platform) or pending (still open without a payment). unpaidValue, canceledValue and pendingValue are the real order totals, not an estimate. Each order is counted once, in its newest copy. VTEX: vtex_orders by creation_date; paid = authorized_date set; canceled = status canceled / cancelled / cancellation-requested; value = value. Tray: tray_orders by date; paid = payment_date set (has_payment is TRUE on every order, so it is not read); canceled = order_status_type canceled/cancelled or a status label starting with CANCELADO; value = total. Shopify does not extract the payment method: supported is false, methods is empty and the totals are zeros (no warehouse read). Null or blank payment methods are bucketed as (sem valor). Aggregates only: no customer data. Both dates are required; the period spans at most 366 days.
ClientIdAuthClientSecretAuthx-client-id<token>Client ID
x-client-secret<token>Client secret
organizationId*stringOrganization identifier (UUID, required)
uuidplatform*stringStore platform. shopify answers supported: false.
"vtex""tray""shopify"startDate*stringFirst creation day of the period, inclusive (YYYY-MM-DD, UTC). Required.
dateendDate*stringLast creation day of the period, inclusive (YYYY-MM-DD, UTC). Required. At most 366 days from startDate.
dategtmMotionId?stringGTM motion da organização (UUID), como listada por GET /v1/gtm-motions. Opcional: sem ele, a resposta cobre a GTM motion padrão da organização. Este endpoint ainda não é recortado por GTM motion: a motion padrão responde com os dados da organização, os mesmos números de quando o parâmetro é omitido, e qualquer outra GTM motion da organização recebe 422 GTM_MOTION_DATA_NOT_AVAILABLE. Não UUID: 400. GTM motion que não é uma motion ativa da organização: 403 GTM_MOTION_NOT_IN_ORGANIZATION.
uuidPayment outcomes of the orders created in the period
application/json- response
period*platform*string"vtex""tray""shopify"supported*booleanfalse when the platform does not extract the payment method (Shopify): totals are zeros and methods is empty
totals*methods*array<>One item per payment method, by createdOrders desc; empty without orders
curl -X GET "https://example.com/v1/orders/payment-outcomes?organizationId=11111111-1111-4111-8111-111111111111&platform=vtex&startDate=2026-10-25&endDate=2026-10-31>mMotionId=019a5b2e-7c4d-7abc-8def-0123456789ab"{ "period": { "startDate": "2026-10-25", "endDate": "2026-10-31" }, "platform": "vtex", "supported": true, "totals": { "createdOrders": 5373, "paidOrders": 4298, "paymentRate": 79.99, "unpaidOrders": 1075, "unpaidValue": 536425, "canceledOrders": 420, "canceledValue": 209580, "pendingOrders": 655, "pendingValue": 326845 }, "methods": [ { "paymentMethod": "Visa", "createdOrders": 3439, "paidOrders": 3141, "paymentRate": 91.33, "unpaidOrders": 298, "unpaidValue": 148702, "canceledOrders": 280, "canceledValue": 139720, "pendingOrders": 18, "pendingValue": 8982 }, { "paymentMethod": "Pix", "createdOrders": 1934, "paidOrders": 1157, "paymentRate": 59.82, "unpaidOrders": 777, "unpaidValue": 387723, "canceledOrders": 140, "canceledValue": 69860, "pendingOrders": 637, "pendingValue": 317863 } ]}