REST API

All jobs can be triggered manually through their REST endpoints. Most endpoints support the following optional parameters:

  • delta — when provided for an extract job, the job only processes entities that were updated or created after this date.

  • name — when provided, the job execution is given this name (useful for correlation in logs).

Param Format

name

String

delta

yyyy-MM-dd’T’HH:mm:ss.SSSXXX

Endpoints:

HTTP Method Path Job type Supported parameters

POST

/job/sellers-extract

Individual Sellers extract

delta, name

POST

/job/professional-sellers-extract

Professional Sellers extract

delta, name

POST

/job/bank-accounts-extract

Bank accounts extract

delta, name

POST

/job/invoices-extract

Invoices extract

delta, name

POST

/job/process-notifications

Notification Processing

name
The process-notifications endpoint triggers one immediate execution of the Notification Processing Job, which picks up any PENDING or eligible RETRYING notifications and processes them. The delta parameter is not applicable to this job.

See example of valid execution requests:

curl --location --request POST \
  'http://localhost:8080/job/bank-accounts-extract?delta=2020-11-22T11:52:00.000-00:00&name=bankAccountExtractJob'

curl --location --request POST \
  'http://localhost:8080/job/process-notifications?name=manualNotificationRun'