Sepa Export

Sepa Export API

This is the documentation for version 0.1 of the API. Last update on Jul 1, 2021.

Base URL
https://api.emporix.io/sepa-export

Jobs

Get list of Sepa Export jobs for tenant

Headers
  • scopes Required / string

    Requires scope: sepaexport.job_view

Path parameters
  • tenant Required / string

    The name of the tenant

Query parameters
  • siteCode Required / string

    The name of the siteCode

  • pageNumber integer(int32)

    The number of the page

    Minimum value is 1. Default value is 1.

  • pageSize integer(int32)

    The size of the page

    Minimum value is 1. Default value is 16.

  • sort string

    The sorting direction

    Values are ASC and DESC. Default value is DESC.

Responses
  • 200 object

    List of jobs

    • active boolean
    • completedAt string(date-time)
    • createdAt string(date-time)
    • fileId string
    • jobId string
    • ordersExportedCount integer(int32)
    • siteCode string
    • status string
  • 400

    Wrong query parameters provided

  • 401

    Not authorized

GET /{tenant}/jobs
$ curl \
 -X GET https://api.emporix.io/sepa-export/{tenant}/jobs?siteCode=string \
 -H "scopes: string"
Response example (200)
{
  "active": true,
  "completedAt": "2021-05-04T09:42:00+00:00",
  "createdAt": "2021-05-04T09:42:00+00:00",
  "fileId": "string",
  "jobId": "string",
  "ordersExportedCount": 42,
  "siteCode": "string",
  "status": "string"
}

Create new Sepa Export job for tenant

Headers
  • scopes Required / string

    Requires scope: sepaexport.job_manage

Path parameters
  • tenant Required / string

    The name of the tenant

Body
  • siteCode Required / string
Responses
  • 200 object

    Not used, but it's always autogenerated

    • id string
  • 201 object

    New job id

    • id string
  • 401

    Not authorized

  • 409 object

    Another job is in progress. You can have only one job at the same time.

    • message string
POST /{tenant}/jobs
$ curl \
 -X POST https://api.emporix.io/sepa-export/{tenant}/jobs \
 -H "Content-Type: application/json" \
 -H "scopes: string" \
 -d '{"siteCode":"string"}'
Request payload example
# Headers
scopes: string

# Payload
{
  "siteCode": "string"
}
Response example (200)
{
  "id": "string"
}
Response example (201)
{
  "id": "string"
}
Response example (409)
{
  "message": "string"
}

Root

Get Sepa Export file by id for tenant

Headers
  • scopes Required / string

    Requires scope: sepaexport.media_view

Path parameters
  • tenant Required / string

    The name of the tenant

  • fileId Required / string

    The id of the file

Responses
  • 200 object

    Sepa Export file

    • inputStream object
    • lastModified integer(int64)
    • length integer(int64)
    • mediaType object
      • charset object
        • aliases array[string]
        • name string
        • registered boolean
      • extension string
      • name string
      • parameters array[string]
      • quality string
      • qualityAsNumber number
      • subtype string
      • textBased boolean
      • type string
      • version string
  • 401

    Not authorized

  • 404 object

    File with given id has not been found.

    • message string
GET /{tenant}/files/{fileId}
$ curl \
 -X GET https://api.emporix.io/sepa-export/{tenant}/files/{fileId} \
 -H "scopes: string"
Response example (200)
{
  "inputStream": {},
  "lastModified": 42,
  "length": 42,
  "mediaType": {
    "charset": {
      "aliases": [
        "string"
      ],
      "name": "string",
      "registered": true
    },
    "extension": "string",
    "name": "string",
    "parameters": [
      "string"
    ],
    "quality": "string",
    "qualityAsNumber": 42.0,
    "subtype": "string",
    "textBased": true,
    "type": "string",
    "version": "string"
  }
}
Response example (404)
{
  "message": "string"
}