Orders

GET

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

Retrieve Tray orders with payment, shipping, and status data

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

Tray orders response

Body

🟠400Bad Request

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.data.v4.marketing/v1/tray/orders?workspaceId=workspace_123&organizationId&integrationId&page&limit&orderBy&orderDirection&createdStart&createdEnd&lastModifiedStart&lastModifiedEnd&paymentDateStart&paymentDateEnd&orderStatus&status&id&paymentMethodType&customerId&deliveredStatus&partnerId' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'

Response Example

200 - Exemplo 1

{
    "data": [
        {
            "status": "string",
            "id": "string",
            "date": "2019-08-24T14:15:22.123Z",
            "hour": "string",
            "customer_id": "string",
            "partial_total": 0,
            "taxes": 0,
            "discount": 0,
            "point_sale": "string",
            "shipment": "string",
            "shipment_value": 0,
            "shipment_date": "2019-08-24T14:15:22.123Z",
            "delivered": true,
            "delivered_status": "string",
            "shipping_cancelled": true,
            "store_note": "string",
            "customer_note": "string",
            "partner_id": "string",
            "discount_coupon": "string",
            "client_ip": "string",
            "payment_method_rate": 0,
            "installment": "string",
            "value_1": 0,
            "sending_code": "string",
            "sending_date": "2019-08-24T14:15:22.123Z",
            "billing_address": "string",
            "delivery_time": "string",
            "payment_method_id": "string",
            "payment_method": "string",
            "session_id": "string",
            "total": 0,
            "payment_date": "2019-08-24T14:15:22.123Z",
            "access_code": "string",
            "shipment_integrator": "string",
            "modified": "2019-08-24T14:15:22.123Z",
            "printed": true,
            "interest": 0,
            "cart_additional_values_discount": 0,
            "cart_additional_values_increase": 0,
            "id_quotation": "string",
            "estimated_delivery_date": "2019-08-24T14:15:22.123Z",
            "is_traceable": true,
            "external_code": "string",
            "tracking_url": "string",
            "has_payment": true,
            "has_shipment": true,
            "has_invoice": true,
            "delivery_date": "2019-08-24T14:15:22.123Z",
            "total_comission_user": 0,
            "total_comission": 0,
            "cost": 0,
            "app_id": "string",
            "store_segment": "string",
            "payment_method_type": "string",
            "coupon": 0,
            "order_status_type": "string",
            "order_status": "string",
            "order_status_id": "string",
            "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:44:57