Tray

Pedidos

GET
/v1/tray/orders

Retorna pedidos Tray com dados de pagamento, envio e status

Autorização

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Parâmetros de query

organizationId*string

Identificador da organização (obrigatório)

integrationId?string

Identificador da integração Tray

integrationName?string

Nome da integração Tray

page?integer

Número da página (padrão 1)

Padrão1
limit?integer

Itens por página (padrão 500, máx. 5000)

Intervalovalue <= 5000
Padrão500
id?string

Filtrar por ID do pedido

trayCustomerId?string

Filtrar por ID do cliente Tray

orderStatus?string

Filtrar por status do pedido Tray

status?string

Filtrar pelo campo de status legado

paymentMethodType?string

Filtrar por tipo de método de pagamento

deliveredStatus?string

Filtrar por status de entrega

partnerId?string

Filtrar por ID do parceiro

createdStart?string

Filtrar por data de criação inicial

Formatodate-time
createdEnd?string

Filtrar por data de criação final

Formatodate-time
lastModifiedStart?string

Filtrar por última modificação inicial

Formatodate-time
lastModifiedEnd?string

Filtrar por última modificação final

Formatodate-time
paymentDateStart?string

Filtrar por data de pagamento inicial

Formatodate-time
paymentDateEnd?string

Filtrar por data de pagamento final

Formatodate-time

Corpo da resposta

Resposta de pedidos Tray

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/tray/orders?organizationId=org_123"
{  "data": [    {      "status": "string",      "id": "string",      "date": "2019-08-24T14:15:22Z",      "hour": "string",      "tray_customer_id": "string",      "partial_total": 0.1,      "taxes": 0.1,      "discount": 0.1,      "point_sale": "string",      "shipment": "string",      "shipment_value": 0.1,      "shipment_date": "2019-08-24T14:15:22Z",      "delivered": true,      "delivered_status": "string",      "shipping_cancelled": true,      "partner_id": "string",      "discount_coupon": "string",      "payment_method_rate": 0.1,      "installment": "string",      "value_1": 0.1,      "sending_date": "2019-08-24T14:15:22Z",      "delivery_time": "string",      "payment_method_id": "string",      "payment_method": "string",      "session_id": "string",      "total": 0.1,      "payment_date": "2019-08-24T14:15:22Z",      "shipment_integrator": "string",      "modified": "2019-08-24T14:15:22Z",      "printed": true,      "interest": 0.1,      "cart_additional_values_discount": 0.1,      "cart_additional_values_increase": 0.1,      "id_quotation": "string",      "estimated_delivery_date": "2019-08-24T14:15:22Z",      "is_traceable": true,      "external_code": "string",      "has_payment": true,      "has_shipment": true,      "has_invoice": true,      "delivery_date": "2019-08-24T14:15:22Z",      "total_comission_user": 0.1,      "total_comission": 0.1,      "cost": 0.1,      "app_id": "string",      "store_segment": "string",      "payment_method_type": "string",      "coupon": 0.1,      "order_status_type": "string",      "order_status": "string",      "order_status_id": "string",      "integration_id": "string",      "organization_id": "string",      "user_id": "string",      "document_id": "string",      "integration_name": "string",      "inserted_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}