Jobs

Retrieving a list of export jobs

get

Retrieves a list of Sepa Export jobs.


Required scopes

  • sepaexport.job_view

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: 1Optional

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.

Default: 1
pageSizeinteger · int32 · min: 1Optional

Number of export files to be retrieved per page.

Default: 16
sortstring · enumOptional

List of properties used to sort the results, separated by commas. Possible values:

  • ASC
  • DESC
Default: DESCPossible values:
Responses
200
List of jobs
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"
  }
]

Creating a new export job

post

Creates a new Sepa Export job.


Required scopes

  • sepaexport.job_manage

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
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?