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, see the API release lifecycle documentation. List custom services

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities after given Id

Example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00

sizeinteger · min: 1 · max: 500Optional

number of entities to show

Default: 25Example: 25

tenantCustomServiceIdstringOptional

tenantCustomServiceId to filter for

Example: MY-CUSTOM-SERVICE-1

Responses

200

Custom services can 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

get/api/customservices

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

{
  "customServices": [
    {
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "additionalInformation": [
        {
          "nameLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "description": "Please describe the damage in detail",
          "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
          "isMandatory": false,
          "name": "Damage Description",
          "tenantAdditionalInformationId": "AddInfoABC123",
          "valueType": "NUMBER"
        }
      ],
      "created": "2020-02-03T08:45:51.525Z",
      "customAttributes": {},
      "description": "A service that wraps gifts beautifully",
      "executionTimeInMin": 120,
      "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "imageRefs": [
        "https://my-image-host.com/images/custom-service-1.jpg"
      ],
      "itemsRequired": "OPTIONAL",
      "itemsReturnable": false,
      "lastModified": "2020-02-03T09:45:51.525Z",
      "name": "Gift Wrapping",
      "status": "ACTIVE",
      "tenantCustomServiceId": "6db6a29b-143d-4ffd-ab8b-45cd299cdb00",
      "version": 42
    }
  ],
  "total": 42
}

Create custom service

post

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Create custom service

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

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.

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 120

imageRefsstring[] · max: 50Optional

List of linked images for this custom service

Example: ["https://my-image-host.com/images/custom-service-1.jpg"]

itemsRequiredstring · enumRequired

Indicates whether items are required for executing a service job of this custom service

Example: OPTIONALPossible values:

itemsReturnablebooleanOptional

Indicates if the items of the custom service are returnable after execution

Example: false

statusstring · enumRequired

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

Example: ACTIVEPossible values:

tenantCustomServiceIdstring · min: 1Optional

Tenant specific ID of the custom service

Example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00

Responses

201

The custom service was successfully created.

application/json

CustomService

createdstring · date-timeRequired

The date this entity was created by fulfillmenttools. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

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.

descriptionstring · min: 1Optional

Translated description derived from descriptionLocalized based on the requested locale

Example: A service that wraps gifts beautifully

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 120

idstring · min: 1Required

Unique ID of this custom service

Example: 41d43211-g5a1-gg22-a716-ba095e30ds1d

imageRefsstring[] · max: 50Optional

List of linked images for this custom service

Example: ["https://my-image-host.com/images/custom-service-1.jpg"]

itemsRequiredstring · enumRequired

Indicates whether items are required for executing a service job of this custom service

Example: OPTIONALPossible values:

itemsReturnablebooleanOptional

Indicates if the items of the custom service are returnable after execution

Example: false

lastModifiedstring · date-timeRequired

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

namestring · min: 1Optional

Translated name derived from nameLocalized based on the requested locale

Example: Gift Wrapping

statusstring · enumRequired

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

Example: ACTIVEPossible values:

tenantCustomServiceIdstring · min: 1Optional

Tenant specific ID of the custom service

Example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

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

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: 685

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "additionalInformation": [
    {
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "isMandatory": false,
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "NUMBER"
    }
  ],
  "customAttributes": {},
  "executionTimeInMin": 120,
  "imageRefs": [
    "https://my-image-host.com/images/custom-service-1.jpg"
  ],
  "itemsRequired": "OPTIONAL",
  "itemsReturnable": false,
  "status": "ACTIVE",
  "tenantCustomServiceId": "6db6a29b-143d-4ffd-ab8b-45cd299cdb00"
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "additionalInformation": [
    {
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "description": "Please describe the damage in detail",
      "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "isMandatory": false,
      "name": "Damage Description",
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "NUMBER"
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "description": "A service that wraps gifts beautifully",
  "executionTimeInMin": 120,
  "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "imageRefs": [
    "https://my-image-host.com/images/custom-service-1.jpg"
  ],
  "itemsRequired": "OPTIONAL",
  "itemsReturnable": false,
  "lastModified": "2020-02-03T09:45:51.525Z",
  "name": "Gift Wrapping",
  "status": "ACTIVE",
  "tenantCustomServiceId": "6db6a29b-143d-4ffd-ab8b-45cd299cdb00",
  "version": 42
}

Get custom service

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Get custom service

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customServiceIdstringRequired

ID of custom service you want to get

Responses

200

Custom service can be found in response body.

application/json

CustomService

createdstring · date-timeRequired

The date this entity was created by fulfillmenttools. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

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.

descriptionstring · min: 1Optional

Translated description derived from descriptionLocalized based on the requested locale

Example: A service that wraps gifts beautifully

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 120

idstring · min: 1Required

Unique ID of this custom service

Example: 41d43211-g5a1-gg22-a716-ba095e30ds1d

imageRefsstring[] · max: 50Optional

List of linked images for this custom service

Example: ["https://my-image-host.com/images/custom-service-1.jpg"]

itemsRequiredstring · enumRequired

Indicates whether items are required for executing a service job of this custom service

Example: OPTIONALPossible values:

itemsReturnablebooleanOptional

Indicates if the items of the custom service are returnable after execution

Example: false

lastModifiedstring · date-timeRequired

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

namestring · min: 1Optional

Translated name derived from nameLocalized based on the requested locale

Example: Gift Wrapping

statusstring · enumRequired

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

Example: ACTIVEPossible values:

tenantCustomServiceIdstring · min: 1Optional

Tenant specific ID of the custom service

Example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

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

The requested entity was not found

application/json

get/api/customservices/{customServiceId}

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

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "additionalInformation": [
    {
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "description": "Please describe the damage in detail",
      "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "isMandatory": false,
      "name": "Damage Description",
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "NUMBER"
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "description": "A service that wraps gifts beautifully",
  "executionTimeInMin": 120,
  "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "imageRefs": [
    "https://my-image-host.com/images/custom-service-1.jpg"
  ],
  "itemsRequired": "OPTIONAL",
  "itemsReturnable": false,
  "lastModified": "2020-02-03T09:45:51.525Z",
  "name": "Gift Wrapping",
  "status": "ACTIVE",
  "tenantCustomServiceId": "6db6a29b-143d-4ffd-ab8b-45cd299cdb00",
  "version": 42
}

Update custom service

patch

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Apply a patch set or partial update to the custom service.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customServiceIdstringRequired

ID of custom service you want to patch

Body

Responses

200

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

application/json

CustomService

createdstring · date-timeRequired

The date this entity was created by fulfillmenttools. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

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.

descriptionstring · min: 1Optional

Translated description derived from descriptionLocalized based on the requested locale

Example: A service that wraps gifts beautifully

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 120

idstring · min: 1Required

Unique ID of this custom service

Example: 41d43211-g5a1-gg22-a716-ba095e30ds1d

imageRefsstring[] · max: 50Optional

List of linked images for this custom service

Example: ["https://my-image-host.com/images/custom-service-1.jpg"]

itemsRequiredstring · enumRequired

Indicates whether items are required for executing a service job of this custom service

Example: OPTIONALPossible values:

itemsReturnablebooleanOptional

Indicates if the items of the custom service are returnable after execution

Example: false

lastModifiedstring · date-timeRequired

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

namestring · min: 1Optional

Translated name derived from nameLocalized based on the requested locale

Example: Gift Wrapping

statusstring · enumRequired

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

Example: ACTIVEPossible values:

tenantCustomServiceIdstring · min: 1Optional

Tenant specific ID of the custom service

Example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

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

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

patch/api/customservices/{customServiceId}

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

{
  "actions": [
    {
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "action": "ModifyCustomService",
      "executionTimeInMin": 100,
      "imageRefs": [
        "https://my-image-host.com/images/custom-service-1.jpg"
      ],
      "itemsRequired": "OPTIONAL",
      "itemsReturnable": false,
      "status": "ACTIVE",
      "tenantCustomServiceId": "MY-CUSTOM-SERVICE-1"
    }
  ],
  "version": 42
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "additionalInformation": [
    {
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "description": "Please describe the damage in detail",
      "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "isMandatory": false,
      "name": "Damage Description",
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "NUMBER"
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "description": "A service that wraps gifts beautifully",
  "executionTimeInMin": 120,
  "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "imageRefs": [
    "https://my-image-host.com/images/custom-service-1.jpg"
  ],
  "itemsRequired": "OPTIONAL",
  "itemsReturnable": false,
  "lastModified": "2020-02-03T09:45:51.525Z",
  "name": "Gift Wrapping",
  "status": "ACTIVE",
  "tenantCustomServiceId": "6db6a29b-143d-4ffd-ab8b-45cd299cdb00",
  "version": 42
}

Create additional information

post

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Create additional information on the custom service.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

customServiceIdstringRequired

ID of custom service you want to create additional information for

Body

AdditionalInformationForCreation

isMandatorybooleanOptional

Indicates if filling in this additional information is mandatory

Example: false

tenantAdditionalInformationIdstring · min: 1Optional

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

Example: AddInfoABC123

valueTypestring · enumRequired

Type of the value

Example: NUMBERPossible values:

Responses

201

Added additional information to the custom service.

application/json

CustomService

createdstring · date-timeRequired

The date this entity was created by fulfillmenttools. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

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.

descriptionstring · min: 1Optional

Translated description derived from descriptionLocalized based on the requested locale

Example: A service that wraps gifts beautifully

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 120

idstring · min: 1Required

Unique ID of this custom service

Example: 41d43211-g5a1-gg22-a716-ba095e30ds1d

imageRefsstring[] · max: 50Optional

List of linked images for this custom service

Example: ["https://my-image-host.com/images/custom-service-1.jpg"]

itemsRequiredstring · enumRequired

Indicates whether items are required for executing a service job of this custom service

Example: OPTIONALPossible values:

itemsReturnablebooleanOptional

Indicates if the items of the custom service are returnable after execution

Example: false

lastModifiedstring · date-timeRequired

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

namestring · min: 1Optional

Translated name derived from nameLocalized based on the requested locale

Example: Gift Wrapping

statusstring · enumRequired

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

Example: ACTIVEPossible values:

tenantCustomServiceIdstring · min: 1Optional

Tenant specific ID of the custom service

Example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

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

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

post/api/customservices/{customServiceId}/additionalinformation

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: 249

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

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "additionalInformation": [
    {
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "description": "Please describe the damage in detail",
      "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "isMandatory": false,
      "name": "Damage Description",
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "NUMBER"
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "description": "A service that wraps gifts beautifully",
  "executionTimeInMin": 120,
  "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "imageRefs": [
    "https://my-image-host.com/images/custom-service-1.jpg"
  ],
  "itemsRequired": "OPTIONAL",
  "itemsReturnable": false,
  "lastModified": "2020-02-03T09:45:51.525Z",
  "name": "Gift Wrapping",
  "status": "ACTIVE",
  "tenantCustomServiceId": "6db6a29b-143d-4ffd-ab8b-45cd299cdb00",
  "version": 42
}

Update additional information

put

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Update an additional information entry on the custom service.

Authorizations

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

AdditionalInformationForCreation

isMandatorybooleanOptional

Indicates if filling in this additional information is mandatory

Example: false

tenantAdditionalInformationIdstring · min: 1Optional

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

Example: AddInfoABC123

valueTypestring · enumRequired

Type of the value

Example: NUMBERPossible values:

Responses

200

Updated the additional information on the custom service

application/json

CustomService

createdstring · date-timeRequired

The date this entity was created by fulfillmenttools. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

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.

descriptionstring · min: 1Optional

Translated description derived from descriptionLocalized based on the requested locale

Example: A service that wraps gifts beautifully

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 120

idstring · min: 1Required

Unique ID of this custom service

Example: 41d43211-g5a1-gg22-a716-ba095e30ds1d

imageRefsstring[] · max: 50Optional

List of linked images for this custom service

Example: ["https://my-image-host.com/images/custom-service-1.jpg"]

itemsRequiredstring · enumRequired

Indicates whether items are required for executing a service job of this custom service

Example: OPTIONALPossible values:

itemsReturnablebooleanOptional

Indicates if the items of the custom service are returnable after execution

Example: false

lastModifiedstring · date-timeRequired

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

namestring · min: 1Optional

Translated name derived from nameLocalized based on the requested locale

Example: Gift Wrapping

statusstring · enumRequired

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

Example: ACTIVEPossible values:

tenantCustomServiceIdstring · min: 1Optional

Tenant specific ID of the custom service

Example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

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

404

The requested entity was not found

application/json

409

A version conflict occurred.

application/json

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

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: 249

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

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "additionalInformation": [
    {
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "description": "Please describe the damage in detail",
      "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "isMandatory": false,
      "name": "Damage Description",
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "NUMBER"
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "description": "A service that wraps gifts beautifully",
  "executionTimeInMin": 120,
  "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "imageRefs": [
    "https://my-image-host.com/images/custom-service-1.jpg"
  ],
  "itemsRequired": "OPTIONAL",
  "itemsReturnable": false,
  "lastModified": "2020-02-03T09:45:51.525Z",
  "name": "Gift Wrapping",
  "status": "ACTIVE",
  "tenantCustomServiceId": "6db6a29b-143d-4ffd-ab8b-45cd299cdb00",
  "version": 42
}

Delete additional information

delete

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Delete an additional information entry from the custom service.

Authorizations

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. additional information was removed.

application/json

CustomService

createdstring · date-timeRequired

The date this entity was created by fulfillmenttools. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

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.

descriptionstring · min: 1Optional

Translated description derived from descriptionLocalized based on the requested locale

Example: A service that wraps gifts beautifully

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 120

idstring · min: 1Required

Unique ID of this custom service

Example: 41d43211-g5a1-gg22-a716-ba095e30ds1d

imageRefsstring[] · max: 50Optional

List of linked images for this custom service

Example: ["https://my-image-host.com/images/custom-service-1.jpg"]

itemsRequiredstring · enumRequired

Indicates whether items are required for executing a service job of this custom service

Example: OPTIONALPossible values:

itemsReturnablebooleanOptional

Indicates if the items of the custom service are returnable after execution

Example: false

lastModifiedstring · date-timeRequired

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

namestring · min: 1Optional

Translated name derived from nameLocalized based on the requested locale

Example: Gift Wrapping

statusstring · enumRequired

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

Example: ACTIVEPossible values:

tenantCustomServiceIdstring · min: 1Optional

Tenant specific ID of the custom service

Example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

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}

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

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "additionalInformation": [
    {
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "description": "Please describe the damage in detail",
      "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "isMandatory": false,
      "name": "Damage Description",
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "NUMBER"
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "customAttributes": {},
  "description": "A service that wraps gifts beautifully",
  "executionTimeInMin": 120,
  "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "imageRefs": [
    "https://my-image-host.com/images/custom-service-1.jpg"
  ],
  "itemsRequired": "OPTIONAL",
  "itemsReturnable": false,
  "lastModified": "2020-02-03T09:45:51.525Z",
  "name": "Gift Wrapping",
  "status": "ACTIVE",
  "tenantCustomServiceId": "6db6a29b-143d-4ffd-ab8b-45cd299cdb00",
  "version": 42
}

List facility custom services

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. List facility custom service connections

Authorizations

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

startAfterIdstring · min: 1Optional

all entities after given Id

Example: 6db6a29b-143d-4ffd-ab8b-45cd299cdb00

sizeinteger · min: 1 · max: 500Optional

number of entities to show

Default: 25Example: 25

Responses

200

Facility custom service connections can 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

The requested entity was not found

application/json

get/api/facilities/{facilityId}/customservices

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",
      "customServiceRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "executionTimeInMin": 100,
      "facilityRef": "ba095e30-879f-11ee-b9d1-0242ac120002",
      "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "status": "ACTIVE",
      "version": 42
    }
  ],
  "total": 42
}

Get facility custom service

get

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Get a facility custom service connection

Authorizations

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

Facility custom service connection can be found in response body.

application/json

FacilityCustomServiceConnection

createdstring · date-timeRequired

The date this entity was created by fulfillmenttools. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

customServiceRefstring · min: 1Required

ID of the custom service this connection belongs to

Example: 41d43211-g5a1-gg22-a716-ba095e30ds1d

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 100

facilityRefstring · min: 1Required

ID of the facility this connection belongs to

Example: ba095e30-879f-11ee-b9d1-0242ac120002

idstring · min: 1Required

Unique ID of this facility to custom service connection

Example: 41d43211-g5a1-gg22-a716-ba095e30ds1d

lastModifiedstring · date-timeRequired

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

statusstring · enumRequired

Status of the connection between facility and custom service

Example: ACTIVEPossible values:

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

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

The requested entity was not found

application/json

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

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

{
  "created": "2020-02-03T08:45:51.525Z",
  "customServiceRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "executionTimeInMin": 100,
  "facilityRef": "ba095e30-879f-11ee-b9d1-0242ac120002",
  "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "status": "ACTIVE",
  "version": 42
}

Create facility custom service

post

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Create a new facility custom service connection

Authorizations

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

FacilityCustomServiceConnectionForCreation

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 100

statusstring · enumRequired

Status of the connection between facility and custom service

Example: ACTIVEPossible values:

Responses

201

The facility custom service connection was successfully created.

application/json

FacilityCustomServiceConnection

createdstring · date-timeRequired

The date this entity was created by fulfillmenttools. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

customServiceRefstring · min: 1Required

ID of the custom service this connection belongs to

Example: 41d43211-g5a1-gg22-a716-ba095e30ds1d

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 100

facilityRefstring · min: 1Required

ID of the facility this connection belongs to

Example: ba095e30-879f-11ee-b9d1-0242ac120002

idstring · min: 1Required

Unique ID of this facility to custom service connection

Example: 41d43211-g5a1-gg22-a716-ba095e30ds1d

lastModifiedstring · date-timeRequired

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

statusstring · enumRequired

Status of the connection between facility and custom service

Example: ACTIVEPossible values:

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

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}

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"
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "customServiceRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "executionTimeInMin": 100,
  "facilityRef": "ba095e30-879f-11ee-b9d1-0242ac120002",
  "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "status": "ACTIVE",
  "version": 42
}

Delete facility custom service

delete

This part of the API is in Beta status. For details, see the API release lifecycle documentation. Delete a facility custom service connection

Authorizations

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

404

The requested entity was not found

application/json

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

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, see the API release lifecycle documentation. Update an existing facility custom service connection

Authorizations

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

FacilityCustomServiceConnectionForUpdate

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 100

statusstring · enumOptional

New status to set for this facility to custom service connection

Example: ACTIVEPossible values:

versioninteger · int64Required

Version of the documentSet you want to update a document of

Example: 42

Responses

200

The facility custom service connection was successfully created.

application/json

FacilityCustomServiceConnection

createdstring · date-timeRequired

The date this entity was created by fulfillmenttools. This value is generated by the service.

Example: 2020-02-03T08:45:51.525Z

customServiceRefstring · min: 1Required

ID of the custom service this connection belongs to

Example: 41d43211-g5a1-gg22-a716-ba095e30ds1d

executionTimeInMinintegerOptional

Time in minutes the custom service takes to be executed

Example: 100

facilityRefstring · min: 1Required

ID of the facility this connection belongs to

Example: ba095e30-879f-11ee-b9d1-0242ac120002

idstring · min: 1Required

Unique ID of this facility to custom service connection

Example: 41d43211-g5a1-gg22-a716-ba095e30ds1d

lastModifiedstring · date-timeRequired

The date this entity was modified last. This value is generated by the service.

Example: 2020-02-03T09:45:51.525Z

statusstring · enumRequired

Status of the connection between facility and custom service

Example: ACTIVEPossible values:

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

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

404

The requested entity was not found

application/json

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

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
}

{
  "created": "2020-02-03T08:45:51.525Z",
  "customServiceRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "executionTimeInMin": 100,
  "facilityRef": "ba095e30-879f-11ee-b9d1-0242ac120002",
  "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "status": "ACTIVE",
  "version": 42
}

Last updated 7 hours ago