Orders

GET

https://api.data.v4.marketing/v1/shopify/orders

Retrieve Shopify orders with payment, totals, and lifecycle timestamps

Requisição

Authorization

API Key

Adicionar parâmetro em header

x-client-id

Exemplo:

x-client-id: ********************

API Key

Adicionar parâmetro em header

x-client-secret

Exemplo:

x-client-secret: ********************

Parâmetros de Consulta

Respostas

🟢200OK

application/json

Shopify orders response

Body

🟠400Bad Request

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.data.v4.marketing/v1/shopify/orders?workspaceId=workspace_123&organizationId&integrationId&page&limit&orderBy&orderDirection&createdStart&createdEnd&lastModifiedStart&lastModifiedEnd&customerId&storeId&name&closedDateStart&closedDateEnd&processedDateStart&processedDateEnd' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'

Response Example

200 - Exemplo 1

{
    "data": [
        {
            "id": "string",
            "cancelled_at": "2019-08-24T14:15:22.123Z",
            "cancel_reason": "string",
            "closed": true,
            "closed_at": "2019-08-24T14:15:22.123Z",
            "confirmed": true,
            "created_at": "2019-08-24T14:15:22.123Z",
            "currency_code": "string",
            "customer_id": "string",
            "customer_email": "user@example.com",
            "email": "user@example.com",
            "fully_paid": true,
            "name": "string",
            "processed_at": "2019-08-24T14:15:22.123Z",
            "source_name": "string",
            "total_discounts_set_presentment_money_amount": 0,
            "total_discounts_set_presentment_money_currency_code": "string",
            "total_price_set_presentment_money_amount": 0,
            "total_price_set_presentment_money_currency_code": "string",
            "total_received_set_presentment_money_amount": 0,
            "total_received_set_presentment_money_currency_code": "string",
            "total_refunded_set_presentment_money_amount": 0,
            "total_refunded_set_presentment_money_currency_code": "string",
            "total_shipping_price_set_presentment_money_amount": 0,
            "total_shipping_price_set_presentment_money_currency_code": "string",
            "total_tax_set_presentment_money_amount": 0,
            "total_tax_set_presentment_money_currency_code": "string",
            "updated_at": "2019-08-24T14:15:22.123Z",
            "integration_id": "string",
            "workspace_id": "string",
            "organization_id": "string",
            "document_id": "string",
            "inserted_at": "2019-08-24T14:15:22.123Z"
        }
    ],
    "meta": {
        "page": 0,
        "limit": 0,
        "hasNextPage": true,
        "hasPreviousPage": true
    }
}

Modificado em 2025-12-01 14:45:12