Jobs
Authorizations
Path parameters
tenantstringRequired
Your Emporix tenant's name.
Note: The tenant
should always be written in lowercase.
Query parameters
siteCodestringRequired
Site code, defined when a site is created.
pageNumberinteger · int32 · min: 1OptionalDefault:
Page number to be retrieved. The number of the first page is 1.
Note: If the pageNumber
parameter is passed, size of the pages must be specified in the pageSize
parameter.
1
pageSizeinteger · int32 · min: 1OptionalDefault:
Number of export files to be retrieved per page.
16
sortstring · enumOptionalDefault:
List of properties used to sort the results, separated by commas. Possible values:
ASC
DESC
DESC
Possible values: Responses
200
List of jobs
application/json
400
Request syntactically incorrect. Any details will be provided within the response payload.
application/json
401
Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.
application/json
403
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
application/json
get
GET /sepa-export/{tenant}/jobs HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"jobId": "text",
"status": "text",
"siteCode": "text",
"fileId": "text",
"active": true,
"ordersExportedCount": 1,
"createdAt": "2025-07-12T06:55:43.015Z",
"completedAt": "2025-07-12T06:55:43.015Z"
}
]
Authorizations
Path parameters
tenantstringRequired
Your Emporix tenant's name.
Note: The tenant
should always be written in lowercase.
Body
siteCodestring · min: 1Required
Responses
201
New job id
application/json
400
Request syntactically incorrect. Any details will be provided within the response payload.
application/json
401
Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.
application/json
403
Given authorization scopes are not sufficient and do not match scopes required by the endpoint.
application/json
409
Another job is in progress. You can have only one job at the same time.
application/json
post
POST /sepa-export/{tenant}/jobs HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19
{
"siteCode": "main"
}
{
"id": "text"
}
Was this helpful?