COMMERCE CONNECT
/
Job Service
/
Job

Documentation Norce Commerce Connect Job Service (4.0)

The Job Service has Entities and Operations concerned with jobs created in Norce Commerce.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://customer-slug.api-se.norce.tech/commerce/connect/4.0/

Job

Operations

Get Job

Request

Get job information by it's id.
Read more about the method here.

Query
idinteger(int32)required

Job id

curl -i -X GET \
  'https://customer-slug.api-se.norce.tech/commerce/connect/4.0/Job/Get?id=0'

Responses

Success

Body
Failinteger(int32)

Number of items which failed to be imported.

Insertinteger(int32)

Number of inserts in all database tables triggered by import.

IsFinishedboolean

Shows if job is finished.

JobIdinteger(int32)

Job identifier.

LastUpdatedstring(DateTime)

Timestamp when job information was last updated.

RunTimestring(TimeSpan)

Job duration.

Startstring(DateTime)

Job start time.

StatusIdinteger(int32)

Job status:
1 = Initialized
2 = Succeeded
3 = Failed
4 = Validation failed

Stopstring(DateTime)

Job stop time.

StorageNamestring(uri)

Relative path to stored import file.

Totalsinteger(int32)

Total number of import items.

Updatesinteger(int32)

Number of updates in all database tables triggered by import.

Response
{
  "Fail": 0,
  "Insert": 0,
  "IsFinished": true,
  "JobId": 0,
  "LastUpdated": "string",
  "RunTime": "string",
  "Start": "string",
  "StatusId": 0,
  "Stop": "string",
  "StorageName": "http://example.com",
  "Totals": 0,
  "Updates": 0
}

Get Job log

Request

Get log for given job by it's id.
Read more about the method here.

Query
idinteger(int32)required

Job id

curl -i -X GET \
  'https://customer-slug.api-se.norce.tech/commerce/connect/4.0/Job/GetLog?id=0'

Responses

Success

Body
SeverityIdinteger(int32)

Severity of log. 1 = Information, 2 = Warning, 3 = Error

Messagestring

Log message

TimeStampstring(DateTime)

Log timestamp

ImportedRowstring

Affected row from import

Response
{
  "SeverityId": 0,
  "Message": "string",
  "TimeStamp": "string",
  "ImportedRow": "string"
}

List Job

Request

Lists all Jobs in the logs.
Read more about the method here.

curl -i -X GET \
  https://customer-slug.api-se.norce.tech/commerce/connect/4.0/Job/List

Responses

Success

Body
Array [
Failinteger(int32)

Number of items which failed to be imported.

Insertinteger(int32)

Number of inserts in all database tables triggered by import.

IsFinishedboolean

Shows if job is finished.

JobIdinteger(int32)

Job identifier.

LastUpdatedstring(DateTime)

Timestamp when job information was last updated.

RunTimestring(TimeSpan)

Job duration.

Startstring(DateTime)

Job start time.

StatusIdinteger(int32)

Job status:
1 = Initialized
2 = Succeeded
3 = Failed
4 = Validation failed

Stopstring(DateTime)

Job stop time.

StorageNamestring(uri)

Relative path to stored import file.

Totalsinteger(int32)

Total number of import items.

Updatesinteger(int32)

Number of updates in all database tables triggered by import.

]
Response
[
  {
    "Fail": 0,
    "Insert": 0,
    "IsFinished": true,
    "JobId": 0,
    "LastUpdated": "string",
    "RunTime": "string",
    "Start": "string",
    "StatusId": 0,
    "Stop": "string",
    "StorageName": "http://example.com",
    "Totals": 0,
    "Updates": 0
  }
]

Restart Job

Request

Restarts a given Job. The job must have finished (i.e. have status 2 or 3) before it may be restarted. A job can be restarted for two weeks, after that the initial payload is discarded.
Read more about the method here.

Query
idinteger(int32)required

Job id

curl -i -X POST \
  'https://customer-slug.api-se.norce.tech/commerce/connect/4.0/Job/Restart?id=0'

Responses

Success

Body
StatusCodestring

Status of the job

Descriptionstring

Short message describing the job

JobIdstring(int32)

Norce Commerce interal id created for this job. Refer to this for future requests.

ValidationSummaryobject(ValidationSummary)

Validation data for accepted payload

Response
{
  "StatusCode": "string",
  "Description": "string",
  "JobId": "string",
  "ValidationSummary": {
    "NrOfItemsInTotal": 0,
    "NrOfValidationFailures": 0,
    "Messages": [ … ]
  }
}

Healthcheck

Operations