Custom Services (Core)

Endpoints to create, update and read custom services.

List custom services

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25

tenantCustomServiceIdstringOptional

tenantCustomServiceId to filter for

Responses

200

Custom service config could be found in response body.

application/json

StrippedCustomServices

totalintegerOptional

Total number of found entities for this query

Example: 42

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get

/api/customservices

HTTPcURLJavaScriptPython

GET /api/customservices HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "customServices": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42,
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "additionalInformation": [
        {
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "nameLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "isMandatory": true,
          "tenantAdditionalInformationId": "AddInfoABC123",
          "valueType": "STRING"
        }
      ],
      "customAttributes": {},
      "executionTimeInMin": 120,
      "itemsRequired": "MANDATORY",
      "itemsReturnable": true,
      "status": "ENABLED",
      "tenantCustomServiceId": "text"
    }
  ],
  "total": 42
}

Create custom service

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

CustomServiceForCreation

customAttributesobject · nullableOptional

Attributes that can be added to custom service. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.

executionTimeInMinintegerOptionalExample: 120

itemsRequiredstring · enumRequired

ItemsRequiredEnum

Possible values:

itemsReturnablebooleanOptional

statusstring · enumRequired

Deprecated values: ENABLED and DISABLED, use INACTIVE and ACTIVE instead

Possible values:

tenantCustomServiceIdstringOptional

Responses

200

The custom service was successfully updated.

application/json

CustomService

and

201

The custom service was successfully created.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/customservices

HTTPcURLJavaScriptPython

POST /api/customservices HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 583

{
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "additionalInformation": [
    {
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "isMandatory": true,
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "STRING"
    }
  ],
  "customAttributes": {},
  "executionTimeInMin": 120,
  "itemsRequired": "MANDATORY",
  "itemsReturnable": true,
  "status": "ENABLED",
  "tenantCustomServiceId": "text"
}

{
  "additionalInformation": [
    {
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "isMandatory": true,
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "STRING"
    }
  ],
  "description": "text",
  "id": "text",
  "name": "text",
  "status": "ENABLED",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "customAttributes": {},
  "executionTimeInMin": 120,
  "itemsRequired": "MANDATORY",
  "itemsReturnable": true,
  "tenantCustomServiceId": "text"
}

Get custom service

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customServiceIdstringRequired

ID of custom service you want to get

Responses

200

Custom service config could be found in response body.

application/json

CustomService

and

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get

/api/customservices/{customServiceId}

HTTPcURLJavaScriptPython

GET /api/customservices/{customServiceId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "additionalInformation": [
    {
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "isMandatory": true,
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "STRING"
    }
  ],
  "description": "text",
  "id": "text",
  "name": "text",
  "status": "ENABLED",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "customAttributes": {},
  "executionTimeInMin": 120,
  "itemsRequired": "MANDATORY",
  "itemsReturnable": true,
  "tenantCustomServiceId": "text"
}

Update custom service

patch

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customServiceIdstringRequired

ID of custom service you want to patch

Body

application/json

or

Responses

200

custom service was found & patch-set has been applied. The patched custom service is in the body.

application/json

CustomService

and

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

custom service not found

application/json

409

custom service version conflict

application/json

patch

/api/customservices/{customServiceId}

HTTPcURLJavaScriptPython

PATCH /api/customservices/{customServiceId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

{
  "additionalInformation": [
    {
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "isMandatory": true,
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "STRING"
    }
  ],
  "description": "text",
  "id": "text",
  "name": "text",
  "status": "ENABLED",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "customAttributes": {},
  "executionTimeInMin": 120,
  "itemsRequired": "MANDATORY",
  "itemsReturnable": true,
  "tenantCustomServiceId": "text"
}

Create additional information

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customServiceIdstringRequired

ID of custom service you want to create service job for

Body

application/json

AdditionalInformationForCreation

isMandatorybooleanOptional

tenantAdditionalInformationIdstring · min: 1Optional

Id to identifiy the additional information on an external system. Must be unique per CustomService.

Example: AddInfoABC123

valueTypestring · enumRequired

AdditionalInformationValueType

Possible values:

Responses

200

The custom service was successfully updated.

application/json

CustomService

and

201

The custom service was successfully created.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/customservices/{customServiceId}/additionalinformation

HTTPcURLJavaScriptPython

POST /api/customservices/{customServiceId}/additionalinformation HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 248

{
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "isMandatory": true,
  "tenantAdditionalInformationId": "AddInfoABC123",
  "valueType": "STRING"
}

{
  "additionalInformation": [
    {
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "isMandatory": true,
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "STRING"
    }
  ],
  "description": "text",
  "id": "text",
  "name": "text",
  "status": "ENABLED",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "customAttributes": {},
  "executionTimeInMin": 120,
  "itemsRequired": "MANDATORY",
  "itemsReturnable": true,
  "tenantCustomServiceId": "text"
}

Update additional information

put

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customServiceIdstringRequired

ID of custom service

additionalInformationIdstringRequired

ID of additional information you want to put

Body

application/json

AdditionalInformationForCreation

isMandatorybooleanOptional

tenantAdditionalInformationIdstring · min: 1Optional

Id to identifiy the additional information on an external system. Must be unique per CustomService.

Example: AddInfoABC123

valueTypestring · enumRequired

AdditionalInformationValueType

Possible values:

Responses

200

The custom service was successfully updated.

application/json

CustomService

and

201

The custom service was successfully created.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

put

/api/customservices/{customServiceId}/additionalinformation/{additionalInformationId}

HTTPcURLJavaScriptPython

PUT /api/customservices/{customServiceId}/additionalinformation/{additionalInformationId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 248

{
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "isMandatory": true,
  "tenantAdditionalInformationId": "AddInfoABC123",
  "valueType": "STRING"
}

{
  "additionalInformation": [
    {
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "isMandatory": true,
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "STRING"
    }
  ],
  "description": "text",
  "id": "text",
  "name": "text",
  "status": "ENABLED",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "customAttributes": {},
  "executionTimeInMin": 120,
  "itemsRequired": "MANDATORY",
  "itemsReturnable": true,
  "tenantCustomServiceId": "text"
}

Delete additional information

delete

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customServiceIdstringRequired

ID of custom service

additionalInformationIdstringRequired

ID of additional information you want to delete

Responses

200

The custom service was successfully updated.

application/json

CustomService

and

201

The custom service was successfully created.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

delete

/api/customservices/{customServiceId}/additionalinformation/{additionalInformationId}

HTTPcURLJavaScriptPython

DELETE /api/customservices/{customServiceId}/additionalinformation/{additionalInformationId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "additionalInformation": [
    {
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "isMandatory": true,
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "STRING"
    }
  ],
  "description": "text",
  "id": "text",
  "name": "text",
  "status": "ENABLED",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42,
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "customAttributes": {},
  "executionTimeInMin": 120,
  "itemsRequired": "MANDATORY",
  "itemsReturnable": true,
  "tenantCustomServiceId": "text"
}

List facility custom services

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25

Responses

200

Custom service connections could be found in response body.

application/json

StrippedFacilityCustomServiceConnections

totalintegerOptional

Total number of found entities for this query

Example: 42

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get

/api/facilities/{facilityId}/customservices

HTTPcURLJavaScriptPython

GET /api/facilities/{facilityId}/customservices HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "facilityCustomServiceConnections": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "total": 42
}

Get facility custom service

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

customServiceIdstringRequired

ID of the custom service

Responses

200

Custom service connection could be found in response body.

application/json

FacilityCustomServiceConnection

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

404

Entity not found

application/json

get

/api/facilities/{facilityId}/customservices/{customServiceId}

HTTPcURLJavaScriptPython

GET /api/facilities/{facilityId}/customservices/{customServiceId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "customServiceRef": "text",
  "executionTimeInMin": 1,
  "facilityRef": "text",
  "id": "text",
  "status": "ACTIVE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Create facility custom service

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

customServiceIdstringRequired

ID of the custom service

Body

application/json

FacilityCustomServiceConnectionForCreation

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 100

statusstring · enumRequired

FacilityCustomServiceConnectionStatus

Possible values:

Responses

201

The custom service connection was successfully created.

application/json

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

post

/api/facilities/{facilityId}/customservices/{customServiceId}

HTTPcURLJavaScriptPython

POST /api/facilities/{facilityId}/customservices/{customServiceId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "executionTimeInMin": 100,
  "status": "ACTIVE"
}

{
  "customServiceRef": "text",
  "executionTimeInMin": 1,
  "facilityRef": "text",
  "id": "text",
  "status": "ACTIVE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Delete facility custom service

delete

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

customServiceIdstringRequired

ID of the custom service

Responses

200

The custom service connection was successfully deleted.

No content

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

delete

/api/facilities/{facilityId}/customservices/{customServiceId}

HTTPcURLJavaScriptPython

DELETE /api/facilities/{facilityId}/customservices/{customServiceId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update facility custom service

patch

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id}).

customServiceIdstringRequired

ID of the custom service

Body

application/json

FacilityCustomServiceConnectionForUpdate

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 100

statusstring · enumOptional

FacilityCustomServiceConnectionStatus

Possible values:

versioninteger · int64Required

Version of the documentSet you want to update a document of

Example: 42

Responses

200

The custom service connection was successfully created.

application/json

FacilityCustomServiceConnection

400

Invalid input. See response for details

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this endpoint

application/json

patch

/api/facilities/{facilityId}/customservices/{customServiceId}

HTTPcURLJavaScriptPython

PATCH /api/facilities/{facilityId}/customservices/{customServiceId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "executionTimeInMin": 100,
  "status": "ACTIVE",
  "version": 42
}

{
  "customServiceRef": "text",
  "executionTimeInMin": 1,
  "facilityRef": "text",
  "id": "text",
  "status": "ACTIVE",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}