Services (Operations)

Endpoints to create, update and read operative service jobs.

List linked service jobs

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

facilityIdsstring[]Optional

facilities to filter to

statusstring[]Optional

Reference to the statuses you want to get the corresponding linked service jobs

orderBystring · enumOptional

Attribute to order linked service jobs by

Possible values:

channelstring · enumOptional

LinkedServiceJobsFilterChannel

Possible values:

startTargetTimestring · date-timeOptional

Start target date range for linked service jobs

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

endTargetTimestring · date-timeOptional

End target date range for linked service jobs

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

searchTermstringOptional

Search term you want to get the corresponding linked service jobs. Search will be performed on multiple fields, like tenantOrderId, consumerName, tenantArticleId and more

modifiedByUsernamestringOptional

Reference to the username you want to get the corresponding linkedServiceJobs for

Responses

200

LinkedServiceJobs could be found in response body.

application/json

LinkedServiceJobsResult

totalobjectRequired

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/linkedservicejobs

HTTPcURLJavaScriptPython

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

{
  "linkedServiceJobs": [
    {
      "facilityRef": "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05",
      "fullIdentifier": "240429_lorem-42",
      "id": "9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1",
      "includedServiceJobLinkIds": [
        "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"
      ],
      "includedServiceJobRefs": [
        "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"
      ],
      "operativeProcessRef": "text",
      "processRef": "9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1",
      "serviceJobLinks": [],
      "status": "OPEN",
      "targetTime": "2026-03-13T15:18:11.833Z",
      "usersModificationHistory": [
        {
          "modificationDate": "2026-03-13T15:18:11.833Z",
          "userId": "text",
          "username": "text"
        }
      ],
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "total": {}
}

Get linked service jobs

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

linkedServiceJobsIdstringRequired

ID of LinkedServiceJobs you want to get

Responses

200

LinkedServiceJobs could be found in response body.

application/json

LinkedServiceJobs

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/linkedservicejobs/{linkedServiceJobsId}

HTTPcURLJavaScriptPython

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

{
  "facilityRef": "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05",
  "fullIdentifier": "240429_lorem-42",
  "id": "9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1",
  "includedServiceJobLinkIds": [
    "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"
  ],
  "includedServiceJobRefs": [
    "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"
  ],
  "operativeProcessRef": "text",
  "processRef": "9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1",
  "serviceJobLinks": [],
  "status": "OPEN",
  "targetTime": "2026-03-13T15:18:11.833Z",
  "usersModificationHistory": [
    {
      "modificationDate": "2026-03-13T15:18:11.833Z",
      "userId": "text",
      "username": "text"
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Create service job link

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Add a ServiceJobLink to a LinkedServiceJob on root level.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

linkedServiceJobsIdstringRequired

ID of LinkedServiceJobs you want to alter

Body

application/json

ServiceJobLinkForAdding

serviceJobRefstringRequiredExample: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad

Responses

201

The ServiceJobLink was successfully added to the LinkedServiceJobs.

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/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks

HTTPcURLJavaScriptPython

POST /api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "serviceJobRef": "0ed803c2-fa20-48d9-9c1b-0d243937a9ad"
}

{
  "facilityRef": "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05",
  "fullIdentifier": "240429_lorem-42",
  "id": "9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1",
  "includedServiceJobLinkIds": [
    "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"
  ],
  "includedServiceJobRefs": [
    "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"
  ],
  "operativeProcessRef": "text",
  "processRef": "9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1",
  "serviceJobLinks": [],
  "status": "OPEN",
  "targetTime": "2026-03-13T15:18:11.833Z",
  "usersModificationHistory": [
    {
      "modificationDate": "2026-03-13T15:18:11.833Z",
      "userId": "text",
      "username": "text"
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Create service job link

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Add a ServiceJobLink to a ServiceJobLink inside the LinkedServiceJob.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

linkedServiceJobsIdstringRequired

ID of LinkedServiceJobs you want to alter

serviceJobLinkIdstringRequired

ID of ServiceJobLink you want to add the new ServiceJobLink underneath

Body

application/json

ServiceJobLinkForAdding

serviceJobRefstringRequiredExample: 0ed803c2-fa20-48d9-9c1b-0d243937a9ad

Responses

201

The ServiceJobLink was successfully added nested inside the LinkedServiceJobs.

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/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks/{serviceJobLinkId}

HTTPcURLJavaScriptPython

POST /api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks/{serviceJobLinkId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "serviceJobRef": "0ed803c2-fa20-48d9-9c1b-0d243937a9ad"
}

{
  "facilityRef": "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05",
  "fullIdentifier": "240429_lorem-42",
  "id": "9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1",
  "includedServiceJobLinkIds": [
    "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"
  ],
  "includedServiceJobRefs": [
    "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"
  ],
  "operativeProcessRef": "text",
  "processRef": "9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1",
  "serviceJobLinks": [],
  "status": "OPEN",
  "targetTime": "2026-03-13T15:18:11.833Z",
  "usersModificationHistory": [
    {
      "modificationDate": "2026-03-13T15:18:11.833Z",
      "userId": "text",
      "username": "text"
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

List linked service jobs (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

LinkedServiceJobsSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

application/json

LinkedServiceJobsPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

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

application/json

post

/api/linkedservicejobs/search

HTTPcURLJavaScriptPython

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "additionalInformation": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "and": [
      {
        "additionalInformation": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "and": [
          {
            "additionalInformation": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "and": "[Circular Reference]",
            "articleTitles": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "channel": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "consumerName": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "invoiceAddress": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-13T15:18:11.833Z",
              "gt": "2026-03-13T15:18:11.833Z",
              "gte": "2026-03-13T15:18:11.833Z",
              "lt": "2026-03-13T15:18:11.833Z",
              "lte": "2026-03-13T15:18:11.833Z",
              "notEq": "2026-03-13T15:18:11.833Z"
            },
            "linkedServiceJobRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "serviceName": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "shippingAddress": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-13T15:18:11.833Z",
              "gt": "2026-03-13T15:18:11.833Z",
              "gte": "2026-03-13T15:18:11.833Z",
              "lt": "2026-03-13T15:18:11.833Z",
              "lte": "2026-03-13T15:18:11.833Z",
              "notEq": "2026-03-13T15:18:11.833Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "usersModificationHistory": {
              "contains": {
                "username": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "articleTitles": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "channel": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "consumerName": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "invoiceAddress": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-13T15:18:11.833Z",
          "gt": "2026-03-13T15:18:11.833Z",
          "gte": "2026-03-13T15:18:11.833Z",
          "lt": "2026-03-13T15:18:11.833Z",
          "lte": "2026-03-13T15:18:11.833Z",
          "notEq": "2026-03-13T15:18:11.833Z"
        },
        "linkedServiceJobRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "additionalInformation": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "and": "[Circular Reference]",
            "articleTitles": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "channel": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "consumerName": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "invoiceAddress": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-13T15:18:11.833Z",
              "gt": "2026-03-13T15:18:11.833Z",
              "gte": "2026-03-13T15:18:11.833Z",
              "lt": "2026-03-13T15:18:11.833Z",
              "lte": "2026-03-13T15:18:11.833Z",
              "notEq": "2026-03-13T15:18:11.833Z"
            },
            "linkedServiceJobRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "serviceName": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "shippingAddress": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-13T15:18:11.833Z",
              "gt": "2026-03-13T15:18:11.833Z",
              "gte": "2026-03-13T15:18:11.833Z",
              "lt": "2026-03-13T15:18:11.833Z",
              "lte": "2026-03-13T15:18:11.833Z",
              "notEq": "2026-03-13T15:18:11.833Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "usersModificationHistory": {
              "contains": {
                "username": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "serviceName": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "shippingAddress": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-13T15:18:11.833Z",
          "gt": "2026-03-13T15:18:11.833Z",
          "gte": "2026-03-13T15:18:11.833Z",
          "lt": "2026-03-13T15:18:11.833Z",
          "lte": "2026-03-13T15:18:11.833Z",
          "notEq": "2026-03-13T15:18:11.833Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "usersModificationHistory": {
          "contains": {
            "username": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "articleTitles": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "channel": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "consumerName": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "invoiceAddress": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "lastModified": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-13T15:18:11.833Z",
      "gt": "2026-03-13T15:18:11.833Z",
      "gte": "2026-03-13T15:18:11.833Z",
      "lt": "2026-03-13T15:18:11.833Z",
      "lte": "2026-03-13T15:18:11.833Z",
      "notEq": "2026-03-13T15:18:11.833Z"
    },
    "linkedServiceJobRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "additionalInformation": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "and": "[Circular Reference]",
        "articleTitles": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "channel": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "consumerName": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "invoiceAddress": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-13T15:18:11.833Z",
          "gt": "2026-03-13T15:18:11.833Z",
          "gte": "2026-03-13T15:18:11.833Z",
          "lt": "2026-03-13T15:18:11.833Z",
          "lte": "2026-03-13T15:18:11.833Z",
          "notEq": "2026-03-13T15:18:11.833Z"
        },
        "linkedServiceJobRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "serviceName": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "shippingAddress": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-13T15:18:11.833Z",
          "gt": "2026-03-13T15:18:11.833Z",
          "gte": "2026-03-13T15:18:11.833Z",
          "lt": "2026-03-13T15:18:11.833Z",
          "lte": "2026-03-13T15:18:11.833Z",
          "notEq": "2026-03-13T15:18:11.833Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "usersModificationHistory": {
          "contains": {
            "username": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "serviceName": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "shippingAddress": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "status": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "targetTime": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-13T15:18:11.833Z",
      "gt": "2026-03-13T15:18:11.833Z",
      "gte": "2026-03-13T15:18:11.833Z",
      "lt": "2026-03-13T15:18:11.833Z",
      "lte": "2026-03-13T15:18:11.833Z",
      "notEq": "2026-03-13T15:18:11.833Z"
    },
    "tenantOrderId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "usersModificationHistory": {
      "contains": {
        "username": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    }
  },
  "size": 1,
  "sort": [
    {
      "lastModified": "ASC",
      "targetTime": "ASC"
    }
  ]
}

{
  "linkedServiceJobs": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

List service containers

get

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeinteger · max: 500Optional

number of entities to show

Default: 25

facilityRefsstring[] · max: 50Optional

Reference of the facility you want to filter for

serviceJobRefstringOptional

Reference of the service job you want to filter for

orderBystringOptional

sorting for the results

Responses

200

Service Jobs could be found in response body.

application/json

ServiceContainers

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/servicecontainers

HTTPcURLJavaScriptPython

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

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

Create service container

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ServiceContainerForCreation

customAttributesobjectOptional

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

operativeContainerTypeRefstringRequired

Reference to the operative container type this container is based on.

scannableCodesstring[] · max: 50Optional

Codes that can be used for scanning this container.

serviceJobRefstringRequired

Id of the ServiceJob this container belongs to.

storageLocationRefstringOptional

Id of the storage location this container is located at.

Responses

201

The service container 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

404

Entity not found

application/json

post

/api/servicecontainers

HTTPcURLJavaScriptPython

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

{
  "customAttributes": {},
  "lineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "operativeContainerTypeRef": "text",
  "scannableCodes": [
    "text"
  ],
  "serviceJobRef": "text",
  "storageLocationRef": "text"
}

{
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "customAttributes": {},
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "facilityRef": "text",
  "iconUrl": "text",
  "id": "text",
  "lineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "name": "text",
  "operativeContainerTypeRef": "text",
  "scannableCodes": [
    "text"
  ],
  "serviceJobRef": "text",
  "storageLocationRef": "text",
  "type": "VIRTUAL",
  "weightLimitInG": 1,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get service container by id

get

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceContainerIdstringRequired

ID of the service container to retrieve

Responses

200

Service container for the given id.

application/json

ServiceContainer

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/servicecontainers/{serviceContainerId}

HTTPcURLJavaScriptPython

GET /api/servicecontainers/{serviceContainerId} 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": "значение"
  },
  "customAttributes": {},
  "description": "text",
  "dimensions": {
    "heightInCm": 50,
    "lengthInCm": 100,
    "weightInG": 1700,
    "widthInCm": 25.5
  },
  "facilityRef": "text",
  "iconUrl": "text",
  "id": "text",
  "lineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "name": "text",
  "operativeContainerTypeRef": "text",
  "scannableCodes": [
    "text"
  ],
  "serviceJobRef": "text",
  "storageLocationRef": "text",
  "type": "VIRTUAL",
  "weightLimitInG": 1,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Delete service container

delete

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceContainerIdstringRequired

ID of the service container to delete

Responses

200

The service container was successfully deleted.

No content

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

delete

/api/servicecontainers/{serviceContainerId}

HTTPcURLJavaScriptPython

DELETE /api/servicecontainers/{serviceContainerId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List service jobs

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

facilityRefstringOptional

Reference of the facility you want to filter for

assignedUserstringOptional

Reference the assigned user on this entity - id or username

statusstring[]Optional

Reference to the statuses you want to get the corresponding service job

channelstring · enumOptional

ServiceJobFilterChannel

Possible values:

startTargetTimestring · date-timeOptional

Start target date range for service jobs

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

endTargetTimestring · date-timeOptional

End target date range for service jobs

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

searchTermstringOptional

Search term you want to get the corresponding service jobs. Search will be performed on multiple fields, like tenantOrderId, consumerName, tenantArticleId and more

Responses

200

Service Jobs could be found in response body.

application/json

ServiceJobs

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/servicejobs

HTTPcURLJavaScriptPython

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

{
  "serviceJobs": [
    {
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "additionalInformation": [
        {
          "description": "text",
          "id": "text",
          "name": "text",
          "descriptionLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "nameLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "isMandatory": true,
          "tenantAdditionalInformationId": "AddInfoABC123",
          "valueType": "STRING"
        }
      ],
      "anonymized": false,
      "assignedUsers": [
        {
          "userId": "text",
          "username": "text"
        }
      ],
      "customAttributes": {},
      "customServiceRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "description": "text",
      "editor": {
        "userId": "text",
        "username": "text"
      },
      "executionTimeInMin": 1,
      "facilityRef": "text",
      "id": "text",
      "itemsRequired": "MANDATORY",
      "itemsReturnable": true,
      "lineItems": [
        {
          "article": {},
          "customAttributes": {},
          "globalLineItemId": "text",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "quantity": 1,
          "recordableAttributes": [
            {
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "group": "general",
              "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "key": "country of origin",
              "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "recordingRule": "MANDATORY",
              "value": "Germany"
            }
          ],
          "scannableCodes": [
            "text"
          ]
        }
      ],
      "linkedServiceJobsRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "name": "text",
      "operativeProcessRef": "text",
      "processRef": "text",
      "requiredLineItems": [
        {
          "article": {
            "titleLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "customAttributes": {},
            "imageUrl": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "assignedItems": [
            {
              "quantity": 12,
              "serviceDataLineItemId": "41d43211-g5a1-gg22-a716-ba095e30ds1d"
            }
          ],
          "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
          "measurementUnitKey": "pcs",
          "quantity": 12,
          "scannableCodes": [
            "text"
          ]
        }
      ],
      "shortId": "KD-12-1",
      "status": "OPEN",
      "statusInformation": {
        "cancelReason": {
          "reasonLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "reason": "Broken Item"
        }
      },
      "subStatus": "LINE_ITEMS_MISSING",
      "targetTime": "2020-02-03T09:45:51.525Z",
      "tenantCustomServiceId": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "tenantOrderId": "ocff-order-100",
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 42
    }
  ],
  "total": 42
}

Create service job

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

ServiceJobForCreation

customAttributesobjectOptional

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

customServiceRefstringOptional

ID of the Custom Service, the Service Job should reference. Either this and/or the tenantCustomServiceId must passed.

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

facilityRefstringRequired

ID of the Facility, the Service Job is executed in.

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

operativeProcessRefstringOptional

processRefstringOptional

ID of the Process, the Service Job belongs to.

Example: 550e8400-e29b-41d4-a716-446655440000

serviceJobLinkRefstringOptional

ID of the Service Job Link, the Service Job should reference.

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

shortIdstringOptionalExample: KD-12-1

targetTimestring · date-timeRequired

At which time the service job is expected to be finished.

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

tenantCustomServiceIdstringOptional

Tenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.

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

tenantOrderIdstringOptional

ID of the tenant order, the linked service jobs are part of

Example: ocff-order-100

Responses

201

The service job 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/servicejobs

HTTPcURLJavaScriptPython

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

{
  "additionalInformation": [
    {
      "additionalInformationRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "tenantAdditionalInformationRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "value": "some value"
    }
  ],
  "assignedUsers": [
    {
      "username": "text"
    }
  ],
  "customAttributes": {},
  "customServiceRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "facilityRef": "ba095e30-879f-11ee-b9d1-0242ac120002",
  "lineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "operativeProcessRef": "text",
  "processRef": "550e8400-e29b-41d4-a716-446655440000",
  "requiredLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "measurementUnitKey": "pcs",
      "quantity": 12,
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "serviceJobLinkRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "shortId": "KD-12-1",
  "targetTime": "2020-02-03T09:45:51.525Z",
  "tenantCustomServiceId": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "tenantOrderId": "ocff-order-100"
}

{
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "additionalInformation": [
    {
      "description": "text",
      "id": "text",
      "name": "text",
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "isMandatory": true,
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "STRING"
    }
  ],
  "anonymized": false,
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "customAttributes": {},
  "customServiceRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "description": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "executionTimeInMin": 1,
  "facilityRef": "text",
  "id": "text",
  "itemsRequired": "MANDATORY",
  "itemsReturnable": true,
  "lineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "linkedServiceJobsRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "name": "text",
  "operativeProcessRef": "text",
  "processRef": "text",
  "requiredLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "assignedItems": [
        {
          "quantity": 12,
          "serviceDataLineItemId": "41d43211-g5a1-gg22-a716-ba095e30ds1d"
        }
      ],
      "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "measurementUnitKey": "pcs",
      "quantity": 12,
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "shortId": "KD-12-1",
  "status": "OPEN",
  "statusInformation": {
    "cancelReason": {
      "reasonLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "reason": "Broken Item"
    }
  },
  "subStatus": "LINE_ITEMS_MISSING",
  "targetTime": "2020-02-03T09:45:51.525Z",
  "tenantCustomServiceId": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "tenantOrderId": "ocff-order-100",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get service job

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

serviceJobIdstringRequired

ID of service job you want to get

Responses

200

Service Job could be found in response body.

application/json

ServiceJob

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/servicejobs/{serviceJobId}

HTTPcURLJavaScriptPython

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

{
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "additionalInformation": [
    {
      "description": "text",
      "id": "text",
      "name": "text",
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "isMandatory": true,
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "STRING"
    }
  ],
  "anonymized": false,
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "customAttributes": {},
  "customServiceRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "description": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "executionTimeInMin": 1,
  "facilityRef": "text",
  "id": "text",
  "itemsRequired": "MANDATORY",
  "itemsReturnable": true,
  "lineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "linkedServiceJobsRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "name": "text",
  "operativeProcessRef": "text",
  "processRef": "text",
  "requiredLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "assignedItems": [
        {
          "quantity": 12,
          "serviceDataLineItemId": "41d43211-g5a1-gg22-a716-ba095e30ds1d"
        }
      ],
      "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "measurementUnitKey": "pcs",
      "quantity": 12,
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "shortId": "KD-12-1",
  "status": "OPEN",
  "statusInformation": {
    "cancelReason": {
      "reasonLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "reason": "Broken Item"
    }
  },
  "subStatus": "LINE_ITEMS_MISSING",
  "targetTime": "2020-02-03T09:45:51.525Z",
  "tenantCustomServiceId": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "tenantOrderId": "ocff-order-100",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Call service job action

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

serviceJobIdstringRequired

ID of service job you want to update

Body

application/json

ServiceJobActionsParameter

or

or

or

or

or

or

or

or

Responses

200

The service job was successfully updated.

application/json

ServiceJob

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/servicejobs/{serviceJobId}/actions

HTTPcURLJavaScriptPython

POST /api/servicejobs/{serviceJobId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "additionalInformation": [
    {
      "additionalInformationRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "tenantAdditionalInformationRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "value": "some value"
    }
  ],
  "name": "StartServiceJob",
  "version": 1
}

{
  "descriptionLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "additionalInformation": [
    {
      "description": "text",
      "id": "text",
      "name": "text",
      "descriptionLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "nameLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "isMandatory": true,
      "tenantAdditionalInformationId": "AddInfoABC123",
      "valueType": "STRING"
    }
  ],
  "anonymized": false,
  "assignedUsers": [
    {
      "userId": "text",
      "username": "text"
    }
  ],
  "customAttributes": {},
  "customServiceRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "description": "text",
  "editor": {
    "userId": "text",
    "username": "text"
  },
  "executionTimeInMin": 1,
  "facilityRef": "text",
  "id": "text",
  "itemsRequired": "MANDATORY",
  "itemsReturnable": true,
  "lineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "linkedServiceJobsRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "name": "text",
  "operativeProcessRef": "text",
  "processRef": "text",
  "requiredLineItems": [
    {
      "article": {
        "titleLocalized": {
          "de_DE": "Wert",
          "en_US": "Value",
          "ru_RU": "значение"
        },
        "customAttributes": {},
        "imageUrl": "text",
        "tenantArticleId": "4711",
        "title": "Cologne Water",
        "weight": 1,
        "attributes": [
          {
            "valueLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "keyLocalized": {
              "de_DE": "Wert",
              "en_US": "Value",
              "ru_RU": "значение"
            },
            "category": "descriptive",
            "context": {
              "type": "FACILITY_GROUP",
              "value": "text"
            },
            "key": "%%subtitle%%",
            "priority": 100,
            "type": "STRING",
            "value": "585er Gold"
          }
        ]
      },
      "assignedItems": [
        {
          "quantity": 12,
          "serviceDataLineItemId": "41d43211-g5a1-gg22-a716-ba095e30ds1d"
        }
      ],
      "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
      "measurementUnitKey": "pcs",
      "quantity": 12,
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "shortId": "KD-12-1",
  "status": "OPEN",
  "statusInformation": {
    "cancelReason": {
      "reasonLocalized": {
        "de_DE": "Wert",
        "en_US": "Value",
        "ru_RU": "значение"
      },
      "reason": "Broken Item"
    }
  },
  "subStatus": "LINE_ITEMS_MISSING",
  "targetTime": "2020-02-03T09:45:51.525Z",
  "tenantCustomServiceId": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "tenantOrderId": "ocff-order-100",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

List service containers for a service job

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Lists service containers by the id of the related service job

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

serviceJobIdstringRequired

ID of the service job to retrieve containers for

Responses

200

Service containers for the given service job.

application/json

ServiceContainer

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/servicejobs/{serviceJobId}/servicecontainers

HTTPcURLJavaScriptPython

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

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

Get service data

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

serviceJobIdstringRequired

ID of service job referenced by the service data you want to get

Responses

200

Service Data could be found in response body.

application/json

ServiceData

createdstring · date-timeRequired

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

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

idstringRequired

ID of the Service Data

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

serviceJobRefsstring[] · min: 1Required

IDs of all serviceJobs connected to this service data

Example: cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05

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

Entity not found

application/json

get

/api/servicejobs/{serviceJobId}/servicedata

HTTPcURLJavaScriptPython

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

{
  "availableLineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "serviceJobRefs": [
    "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"
  ],
  "version": 42
}

Call service data action

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

serviceJobIdstringRequired

ID of service job referenced by the service data you want to update

Body

application/json

ServiceDataActionsParameter

or

or

or

or

Responses

200

The service data was successfully updated.

application/json

ServiceData

createdstring · date-timeRequired

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

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

idstringRequired

ID of the Service Data

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

serviceJobRefsstring[] · min: 1Required

IDs of all serviceJobs connected to this service data

Example: cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05

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/servicejobs/{serviceJobId}/servicedata/actions

HTTPcURLJavaScriptPython

POST /api/servicejobs/{serviceJobId}/servicedata/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 157

{
  "name": "SELECT_ITEMS_FOR_SERVICE_JOB",
  "serviceItemsToSelect": [
    {
      "quantity": 1,
      "serviceItemRef": "41d43211-g5a1-gg22-a716-ba095e30ds1d"
    }
  ],
  "serviceJobVersion": 1
}

{
  "availableLineItems": [
    {
      "article": {},
      "customAttributes": {},
      "globalLineItemId": "text",
      "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
      "quantity": 1,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "group": "general",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "key": "country of origin",
          "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ]
    }
  ],
  "created": "2020-02-03T08:45:51.525Z",
  "id": "41d43211-g5a1-gg22-a716-ba095e30ds1d",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "serviceJobRefs": [
    "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"
  ],
  "version": 42
}