Wyzio API documentation

Get list of order reports

GET /api-v1/order-reports

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Responses

• 200

OK
Hide response attributes Show response attributes object
- clientName string
- date string(date-time)
- entityCreatorContactId integer
- id integer
- orderId string
- orderName string
- organizationId integer
- ourContactName string
- profitability number
- totalCost number
- totalRevenue number
- type string
  
  Values are NONE, DAILY, WEEKLY, BI_WEEKLY, EVERY_MONTH, EVERY_2_MONTH, EVERY_3_MONTH, EVERY_4_MONTH, EVERY_6_MONTH, or ANNUAL.
• 400

400 Bad Request
• 401

401 Unauthorized
• 403

403 Access Denied
• 404

404 Not Found
• 500

500 Internal Server Error

GET /api-v1/order-reports

curl \
 -X GET http://wyzio.app/api-v1/order-reports \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

[
  {
    "clientName": "string",
    "date": "2024-05-04T09:42:00+00:00",
    "entityCreatorContactId": 42,
    "id": 42,
    "orderId": "string",
    "orderName": "string",
    "organizationId": 42,
    "ourContactName": "string",
    "profitability": 42.0,
    "totalCost": 42.0,
    "totalRevenue": 42.0,
    "type": "NONE"
  }
]