Skip to content

Create export request

POST
/rest/reporting/exports/create
curl --request POST \
--url https://api.shypr.app/rest/reporting/exports/create \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <X-API-KEY>' \
--data '{ "type": "customer", "format": "pdf", "startDate": "2026-04-15T12:00:00Z", "endDate": "2026-04-15T12:00:00Z" }'

Creates a ExportRequest resource.

The new ExportRequest resource

object
type
required
string
Allowed values: customer supplier complaint rfm quote proforma salesOrder invoice creditNote purchaseOrder inventory product product.units-sold packinglist cbs.intrastat
format
required
string
Allowed values: pdf xlsx json array
startDate
required
string format: date-time
endDate
required
string format: date-time

ExportRequest resource created

object
records
integer | null
0
finishedAt
string | null format: date-time
type
string
Allowed values: customer supplier complaint rfm quote proforma salesOrder invoice creditNote purchaseOrder inventory product product.units-sold packinglist cbs.intrastat
format
string
Allowed values: pdf xlsx json array
startDate
string format: date-time
endDate
string format: date-time
creator
string format: iri-reference
createdAt
string format: date-time
updatedAt
string | null format: date-time
file
string | null format: iri-reference
id

More information

string format: uuid
uid
string
dateRange
object
start
string format: date-time
end
string format: date-time
diffYears
Array<integer>
finished
boolean
results
boolean

Example

{
"records": 0,
"type": "customer",
"format": "pdf",
"creator": "https://example.com/",
"file": "https://example.com/"
}

Invalid input

A representation of common errors.

object
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string

Example

{
"status": 400
}

Forbidden

A representation of common errors.

object
title

A short, human-readable summary of the problem.

string | null
detail

A human-readable explanation specific to this occurrence of the problem.

string | null
status
integer | null
default: 400
instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

string | null
type

A URI reference that identifies the problem type

string

Example

{
"status": 400
}

An error occurred

Unprocessable entity

object
status
integer
default: 422
violations
Array<object>
object
propertyPath
required

The property path of the violation

string
message
required

The message associated with the violation

string
code

The code of the violation

string
hint

An extra hint to understand the violation

string
payload

The serialized payload of the violation

object
key
additional properties
any
detail
string
type
string
title
string | null
instance
string | null

Example

{
"status": 422
}