GET /external/api/reports/z-report

Query parameters

date string(date-time)
storeId string(uuid)

Responses

200

text/plain

text/plain application/json text/json

Success
Hide headers attribute Show headers attribute
- X-Pagination
  
  meta-data
Hide response attributes Show response attributes object
- id string(uuid)
- storeId string(uuid)
- title string | null
- reportUrl string | null
- reportType string
  
  Values are x, z, or custom.
- createdAt string(date-time)
- reportDate string(date-time) | null
- canBeDeleted boolean
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- id string(uuid)
- storeId string(uuid)
- title string | null
- reportUrl string | null
- reportType string
  
  Values are x, z, or custom.
- createdAt string(date-time)
- reportDate string(date-time) | null
- canBeDeleted boolean
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- id string(uuid)
- storeId string(uuid)
- title string | null
- reportUrl string | null
- reportType string
  
  Values are x, z, or custom.
- createdAt string(date-time)
- reportDate string(date-time) | null
- canBeDeleted boolean
- Additional properties are NOT allowed

curl \
 -X GET https://demo.api.fygi.store/external/api/reports/z-report \
 -H "authorization: $API_KEY"

Response examples (200)

# Headers

# Payload
{
  "id": "string",
  "storeId": "string",
  "title": "string",
  "reportUrl": "string",
  "reportType": "x",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "reportDate": "2024-05-04T09:42:00+00:00",
  "canBeDeleted": true
}

Response examples (200)

# Headers

# Payload
{
  "id": "string",
  "storeId": "string",
  "title": "string",
  "reportUrl": "string",
  "reportType": "x",
  "createdAt": "2024-05-04T09:42:00+00:00",
  "reportDate": "2024-05-04T09:42:00+00:00",
  "canBeDeleted": true
}