V4MOS API
HomeAPI Reference
Changelog
HomeAPI Reference
Changelog
V4 Marketing
  1. VTEX
  • Guia Rápido
  • Facebook Ads
    • Overview
    • Accounts
    • Ads
    • Ad Sets
    • Campaigns
    • Actions
    • Ad Creatives
    • Demographics
    • Platforms
    • Regions
    • Ad Config
    • Ad Set Config
    • Campaigns Config
  • Google Ads
    • Overview
    • Accounts
    • Ad Group Ads
    • Ad Groups
    • Campaigns
    • Keywords
    • Age Range
    • Gender
    • Geographic
    • Conversions
    • Conversion Segmented Ad Group Ads
    • Conversion Segmented Ad Groups
    • Conversion Segmented Campaigns
    • Campaigns Criterion
    • Ad Group Criterion
  • Google Analytics
    • Overview
    • Sessions
    • Events
    • Custom Events
    • Customers
    • Products
    • Transactions
  • Tray
    • Overview
    • Customers
    • Orders
    • Products
  • Shopify
    • Overview
    • Customers
    • Orders
    • Order Items
    • Products
  • Kommo
    • Overview
    • Leads
    • Contacts
    • Pipelines
    • Users
  • HubSpot
    • Overview
    • Contacts
    • Deals
    • Companies
    • Pipelines
    • Products
  • VTEX
    • Customers
      GET
    • Orders
      GET
    • Order items
      GET
  1. VTEX

Orders

GET
https://api.data.v4.marketing/v1/vtex/orders
Retrieve VTEX sales orders with status, totals breakdown, payment, shipping, and marketing attribution (UTMs, coupon).

Requisição

Authorization
or
Parâmetros de Consulta

Respostas

🟢200
application/json
VTEX orders response
Bodyapplication/json

🟠400
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.data.v4.marketing/v1/vtex/orders?organizationId=org_123&userId=undefined&integrationName=undefined&orderId=undefined&status=undefined&dateStart=undefined&dateEnd=undefined&page=undefined&limit=undefined' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'
Response Response Example
200 - Exemplo 1
{
    "data": [
        {
            "order_id": "string",
            "sequence": "string",
            "seller_order_id": "string",
            "origin": "string",
            "affiliate_id": "string",
            "sales_channel": "string",
            "merchant_name": "string",
            "status": "string",
            "status_description": "string",
            "value": 0,
            "creation_date": "2019-08-24T14:15:22.123Z",
            "last_change": "2019-08-24T14:15:22.123Z",
            "order_group": "string",
            "follow_up_email": "string",
            "last_message": "string",
            "is_completed": true,
            "order_form_id": "string",
            "authorized_date": "2019-08-24T14:15:22.123Z",
            "invoiced_date": "2019-08-24T14:15:22.123Z",
            "cancel_reason": "string",
            "tracking_id": "string",
            "courier_name": "string",
            "tracking_url": "string",
            "tracking_labels": "string",
            "utm_source": "string",
            "utm_medium": "string",
            "utm_campaign": "string",
            "utmi_campaign": "string",
            "coupon_code": "string",
            "marketing_tags": "string",
            "total_items_value": 0,
            "total_discounts": 0,
            "total_shipping": 0,
            "total_tax": 0,
            "payment_method": "string",
            "payment_method_group": "string",
            "installments": 0,
            "shipping_city": "string",
            "shipping_state": "string",
            "shipping_country": "string",
            "shipping_postal_code": "string",
            "integration_id": "string",
            "organization_id": "string",
            "organization_id_legacy": "string",
            "user_id": "string",
            "document_id": "string",
            "inserted_at": "2019-08-24T14:15:22.123Z",
            "integration_name": "string"
        }
    ],
    "meta": {
        "page": 0,
        "limit": 0,
        "hasNextPage": true,
        "hasPreviousPage": true
    }
}
Modificado em 2026-06-15 17:34:00
Página anterior
Customers
Próxima página
Order items
Built with