> For the complete documentation index, see [llms.txt](https://docs.fulfillmenttools.com/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fulfillmenttools.com/documentation/apis/api-reference/services-operations.md).

# Services (Operations)

Endpoints to create, update, and read operative service jobs.

## List linked service jobs

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />List linked service jobs

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LinkedServiceJobsResult":{"properties":{"linkedServiceJobs":{"description":"List of linked service jobs matching the query","items":{"$ref":"#/components/schemas/LinkedServiceJobsWithSearchPaths"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","minimum":0,"type":"integer"}},"required":["total","linkedServiceJobs"],"title":"LinkedServiceJobsResult","type":"object","description":"LinkedServiceJobsResult"},"LinkedServiceJobsWithSearchPaths":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"facilityRef":{"description":"Id linked Facility from the includes service jobs","minLength":1,"type":"string"},"fullIdentifier":{"description":"Full identifier of the service job. Using the full name of the customer when created from an order.","minLength":1,"type":"string"},"id":{"description":"Unique ID of this linked service jobs group","minLength":1,"type":"string"},"includedServiceJobLinkIds":{"description":"searchable field of all included service job link ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"includedServiceJobRefs":{"description":"searchable field of all included service job ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this linked service jobs group belongs to","minLength":1,"type":"string"},"processRef":{"description":"ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process","minLength":1,"type":"string"},"searchPaths":{"description":"Search paths used for full-text search indexing of this entity","items":{"type":"string"},"maxItems":200,"type":"array"},"serviceJobLinks":{"description":"Chain of service job links representing the execution order","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":1,"type":"array"},"status":{"description":"Current status of this linked service jobs group","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE","NOT_READY"],"type":"string"},"targetTime":{"description":"Target time by which all linked service jobs are expected to be completed","format":"date-time","type":"string"},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"maxItems":500,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["created","lastModified","version","id","processRef","facilityRef","targetTime","includedServiceJobLinkIds","includedServiceJobRefs","status","serviceJobLinks","searchPaths"],"title":"LinkedServiceJobsWithSearchPaths","type":"object","description":"LinkedServiceJobsWithSearchPaths"},"ServiceJobLink":{"properties":{"id":{"description":"Unique ID of this service job link","minLength":1,"type":"string"},"nextServiceJobLinks":{"description":"Links to the next service jobs in the execution chain","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":0,"type":"array"},"previousServiceJobLinkRefs":{"description":"id of the created previous service job links","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"previousServiceJobRefs":{"description":"IDs of the preceding service job links that must be completed before this one","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"serviceJobRef":{"description":"ID of the service job this link references","minLength":1,"type":"string"}},"required":["serviceJobRef","previousServiceJobRefs","nextServiceJobLinks","id","previousServiceJobLinkRefs"],"title":"ServiceJobLink","type":"object","description":"ServiceJobLink"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/linkedservicejobs":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />List linked service jobs","operationId":"getLinkedServiceJobs","parameters":[{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":500,"minimum":1,"type":"integer"}},{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"facilities to filter to","in":"query","name":"facilityIds","required":false,"schema":{"items":{"type":"string"},"maxItems":20,"type":"array"}},{"description":"Reference to the statuses you want to get the corresponding linked service jobs","in":"query","name":"status","required":false,"schema":{"items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE","NOT_READY"],"type":"string"},"maxItems":10,"type":"array"}},{"description":"sort order","in":"query","name":"orderBy","required":false,"schema":{"enum":["LAST_MODIFIED_ASC","LAST_MODIFIED_DESC","TARGET_TIME_ASC","TARGET_TIME_DESC"],"type":"string"}},{"description":"Start target date range for linked service jobs","in":"query","name":"startTargetTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"End target date range for linked service jobs","in":"query","name":"endTargetTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"type of channel you want to filter for","in":"query","name":"channel","required":false,"schema":{"enum":["COLLECT","SHIPPING"],"type":"string"}},{"description":"Search term you want to get the corresponding linked service jobs. Search will be performed on multiple fields, like tenantOrderId, consumerName, tenantArticleId and more","in":"query","name":"searchTerm","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"Reference to the username you want to get the corresponding linkedServiceJobs for","in":"query","name":"modifiedByUsername","required":false,"schema":{"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedServiceJobsResult"}}},"description":"LinkedServiceJobs can be found in response body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List linked service jobs","tags":["Services (Operations)"]}}}}
```

## Get linked service jobs

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Get linked service jobs by id

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LinkedServiceJobs":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"facilityRef":{"description":"Id linked Facility from the includes service jobs","minLength":1,"type":"string"},"fullIdentifier":{"description":"Full identifier of the service job. Using the full name of the customer when created from an order.","minLength":1,"type":"string"},"id":{"description":"Unique ID of this linked service jobs group","minLength":1,"type":"string"},"includedServiceJobLinkIds":{"description":"searchable field of all included service job link ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"includedServiceJobRefs":{"description":"searchable field of all included service job ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this linked service jobs group belongs to","minLength":1,"type":"string"},"processRef":{"description":"ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process","minLength":1,"type":"string"},"serviceJobLinks":{"description":"Chain of service job links representing the execution order","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":1,"type":"array"},"status":{"description":"Current status of this linked service jobs group","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE","NOT_READY"],"type":"string"},"targetTime":{"description":"Target time by which all linked service jobs are expected to be completed","format":"date-time","type":"string"},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"maxItems":500,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["created","lastModified","version","id","processRef","facilityRef","targetTime","includedServiceJobLinkIds","includedServiceJobRefs","status","serviceJobLinks"],"title":"LinkedServiceJobs","type":"object","description":"LinkedServiceJobs"},"ServiceJobLink":{"properties":{"id":{"description":"Unique ID of this service job link","minLength":1,"type":"string"},"nextServiceJobLinks":{"description":"Links to the next service jobs in the execution chain","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":0,"type":"array"},"previousServiceJobLinkRefs":{"description":"id of the created previous service job links","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"previousServiceJobRefs":{"description":"IDs of the preceding service job links that must be completed before this one","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"serviceJobRef":{"description":"ID of the service job this link references","minLength":1,"type":"string"}},"required":["serviceJobRef","previousServiceJobRefs","nextServiceJobLinks","id","previousServiceJobLinkRefs"],"title":"ServiceJobLink","type":"object","description":"ServiceJobLink"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/linkedservicejobs/{linkedServiceJobsId}":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Get linked service jobs by id","operationId":"getLinkedServiceJobsById","parameters":[{"description":"ID of LinkedServiceJobs you want to get","in":"path","name":"linkedServiceJobsId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedServiceJobs"}}},"description":"LinkedServiceJobs can be found in response body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get linked service jobs","tags":["Services (Operations)"]}}}}
```

## Create service job link

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Add a ServiceJobLink to a LinkedServiceJob on root level.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServiceJobLinkForAdding":{"properties":{"serviceJobRef":{"description":"ID of the service job to add to this linked service jobs group","minLength":1,"type":"string"}},"required":["serviceJobRef"],"title":"ServiceJobLinkForAdding","type":"object","description":"ServiceJobLinkForAdding"},"LinkedServiceJobs":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"facilityRef":{"description":"Id linked Facility from the includes service jobs","minLength":1,"type":"string"},"fullIdentifier":{"description":"Full identifier of the service job. Using the full name of the customer when created from an order.","minLength":1,"type":"string"},"id":{"description":"Unique ID of this linked service jobs group","minLength":1,"type":"string"},"includedServiceJobLinkIds":{"description":"searchable field of all included service job link ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"includedServiceJobRefs":{"description":"searchable field of all included service job ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this linked service jobs group belongs to","minLength":1,"type":"string"},"processRef":{"description":"ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process","minLength":1,"type":"string"},"serviceJobLinks":{"description":"Chain of service job links representing the execution order","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":1,"type":"array"},"status":{"description":"Current status of this linked service jobs group","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE","NOT_READY"],"type":"string"},"targetTime":{"description":"Target time by which all linked service jobs are expected to be completed","format":"date-time","type":"string"},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"maxItems":500,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["created","lastModified","version","id","processRef","facilityRef","targetTime","includedServiceJobLinkIds","includedServiceJobRefs","status","serviceJobLinks"],"title":"LinkedServiceJobs","type":"object","description":"LinkedServiceJobs"},"ServiceJobLink":{"properties":{"id":{"description":"Unique ID of this service job link","minLength":1,"type":"string"},"nextServiceJobLinks":{"description":"Links to the next service jobs in the execution chain","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":0,"type":"array"},"previousServiceJobLinkRefs":{"description":"id of the created previous service job links","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"previousServiceJobRefs":{"description":"IDs of the preceding service job links that must be completed before this one","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"serviceJobRef":{"description":"ID of the service job this link references","minLength":1,"type":"string"}},"required":["serviceJobRef","previousServiceJobRefs","nextServiceJobLinks","id","previousServiceJobLinkRefs"],"title":"ServiceJobLink","type":"object","description":"ServiceJobLink"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Add a ServiceJobLink to a LinkedServiceJob on root level.","operationId":"addServiceJobLink","parameters":[{"description":"ID of LinkedServiceJobs you want to alter","in":"path","name":"linkedServiceJobsId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceJobLinkForAdding"}}},"description":"Desired ServiceJobLink to add","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedServiceJobs"}}},"description":"The ServiceJobLink was successfully added to the LinkedServiceJobs."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create service job link","tags":["Services (Operations)"]}}}}
```

## Create nested service job link

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Add a ServiceJobLink to a ServiceJobLink inside the LinkedServiceJob.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServiceJobLinkForAdding":{"properties":{"serviceJobRef":{"description":"ID of the service job to add to this linked service jobs group","minLength":1,"type":"string"}},"required":["serviceJobRef"],"title":"ServiceJobLinkForAdding","type":"object","description":"ServiceJobLinkForAdding"},"LinkedServiceJobs":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"facilityRef":{"description":"Id linked Facility from the includes service jobs","minLength":1,"type":"string"},"fullIdentifier":{"description":"Full identifier of the service job. Using the full name of the customer when created from an order.","minLength":1,"type":"string"},"id":{"description":"Unique ID of this linked service jobs group","minLength":1,"type":"string"},"includedServiceJobLinkIds":{"description":"searchable field of all included service job link ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"includedServiceJobRefs":{"description":"searchable field of all included service job ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this linked service jobs group belongs to","minLength":1,"type":"string"},"processRef":{"description":"ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process","minLength":1,"type":"string"},"serviceJobLinks":{"description":"Chain of service job links representing the execution order","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":1,"type":"array"},"status":{"description":"Current status of this linked service jobs group","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE","NOT_READY"],"type":"string"},"targetTime":{"description":"Target time by which all linked service jobs are expected to be completed","format":"date-time","type":"string"},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"maxItems":500,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["created","lastModified","version","id","processRef","facilityRef","targetTime","includedServiceJobLinkIds","includedServiceJobRefs","status","serviceJobLinks"],"title":"LinkedServiceJobs","type":"object","description":"LinkedServiceJobs"},"ServiceJobLink":{"properties":{"id":{"description":"Unique ID of this service job link","minLength":1,"type":"string"},"nextServiceJobLinks":{"description":"Links to the next service jobs in the execution chain","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":0,"type":"array"},"previousServiceJobLinkRefs":{"description":"id of the created previous service job links","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"previousServiceJobRefs":{"description":"IDs of the preceding service job links that must be completed before this one","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"serviceJobRef":{"description":"ID of the service job this link references","minLength":1,"type":"string"}},"required":["serviceJobRef","previousServiceJobRefs","nextServiceJobLinks","id","previousServiceJobLinkRefs"],"title":"ServiceJobLink","type":"object","description":"ServiceJobLink"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/linkedservicejobs/{linkedServiceJobsId}/servicejoblinks/{serviceJobLinkId}":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Add a ServiceJobLink to a ServiceJobLink inside the LinkedServiceJob.","operationId":"addNestedServiceJobLink","parameters":[{"description":"ID of LinkedServiceJobs you want to alter","in":"path","name":"linkedServiceJobsId","required":true,"schema":{"type":"string"}},{"description":"ID of ServiceJobLink you want to add the new ServiceJobLink underneath","in":"path","name":"serviceJobLinkId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceJobLinkForAdding"}}},"description":"Desired ServiceJobLink to add","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedServiceJobs"}}},"description":"The ServiceJobLink was successfully added nested inside the LinkedServiceJobs."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create nested service job link","tags":["Services (Operations)"]}}}}
```

## List linked service jobs (search)

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Search for LinkedServiceJobs

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"LinkedServiceJobsSearchPayload":{"properties":{"after":{"deprecated":false,"description":"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`.","type":"string"},"before":{"description":"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).","type":"string"},"last":{"description":"Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.","maximum":250,"minimum":1,"type":"number"},"options":{"$ref":"#/components/schemas/SearchOptions"},"query":{"$ref":"#/components/schemas/LinkedServiceJobsSearchQuery"},"size":{"description":"Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.","maximum":250,"minimum":1,"type":"number"},"sort":{"description":"Use for sorting the result.","items":{"$ref":"#/components/schemas/LinkedServiceJobsSort"},"maxItems":1,"minItems":1,"type":"array"},"startAfterId":{"deprecated":true,"description":"The ID to start after. Deprecated, use `after` with the value provided in `pageInfo.endCursor` instead.","type":"string"}},"required":["query"],"title":"LinkedServiceJobsSearchPayload","type":"object","description":"LinkedServiceJobsSearchPayload"},"SearchOptions":{"properties":{"withTotal":{"description":"Set to true to include the total count of items in the search result.","type":"boolean"}},"title":"SearchOptions","type":"object","description":"SearchOptions"},"LinkedServiceJobsSearchQuery":{"properties":{"additionalInformation":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by additionalInformation"},"and":{"items":{"$ref":"#/components/schemas/LinkedServiceJobsSearchQuery"},"maxItems":500,"type":"array"},"articleTitles":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by articleTitles"},"channel":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by channel"},"consumerName":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by consumerName"},"facilityRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by facilityRef"},"id":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by id"},"invoiceAddress":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by invoiceAddress"},"lastModified":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by lastModified"},"linkedServiceJobRef":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by linkedServiceJobRef"},"or":{"items":{"$ref":"#/components/schemas/LinkedServiceJobsSearchQuery"},"maxItems":500,"type":"array"},"serviceName":{"allOf":[{"$ref":"#/components/schemas/StringListFilter"}],"description":"Search by serviceName"},"shippingAddress":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by shippingAddress"},"status":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by status"},"targetTime":{"allOf":[{"$ref":"#/components/schemas/DateFilter"}],"description":"Search by targetTime"},"tenantOrderId":{"allOf":[{"$ref":"#/components/schemas/StringSearchFilter"}],"description":"Search by tenantOrderId"},"usersModificationHistory":{"allOf":[{"$ref":"#/components/schemas/LinkedServiceJobsUsersModificationHistoryListFilter"}],"description":"Nested list search by usersModificationHistory"}},"title":"LinkedServiceJobsSearchQuery","type":"object","description":"LinkedServiceJobsSearchQuery"},"StringListFilter":{"properties":{"contains":{"$ref":"#/components/schemas/StringEqFilter"}},"title":"StringListFilter","type":"object","description":"StringListFilter"},"StringEqFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"}},"title":"StringEqFilter","type":"object","description":"StringEqFilter"},"StringFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"notEq":{"maxLength":256,"type":"string"},"notIn":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringFilter","type":"object","description":"StringFilter"},"StringSearchFilter":{"properties":{"eq":{"maxLength":256,"type":"string"},"in":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"},"like":{"description":"Search by regex pattern","maxLength":256,"type":"string"},"notEq":{"maxLength":256,"type":"string"},"notIn":{"items":{"maxLength":256,"type":"string"},"maxItems":25,"type":"array"}},"title":"StringSearchFilter","type":"object","description":"StringSearchFilter"},"DateFilter":{"properties":{"after":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events after the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"before":{"description":"Search using ISO‑8601 dates relative to today. Prefix with “–” for past dates. Results include events before the specified date. Example: “–P1D” for yesterday, “P1W” for next week.","maxLength":256,"type":"string"},"eq":{"format":"date-time","type":"string"},"gt":{"format":"date-time","type":"string"},"gte":{"format":"date-time","type":"string"},"lt":{"format":"date-time","type":"string"},"lte":{"format":"date-time","type":"string"},"notEq":{"format":"date-time","type":"string"}},"title":"DateFilter","type":"object","description":"DateFilter"},"LinkedServiceJobsUsersModificationHistoryListFilter":{"properties":{"contains":{"allOf":[{"$ref":"#/components/schemas/LinkedServiceJobsUsersModificationHistoryFilter"}],"description":"Contains returns if at least one entry matches"}},"title":"LinkedServiceJobsUsersModificationHistoryListFilter","type":"object","description":"LinkedServiceJobsUsersModificationHistoryListFilter"},"LinkedServiceJobsUsersModificationHistoryFilter":{"properties":{"username":{"allOf":[{"$ref":"#/components/schemas/StringFilter"}],"description":"Search by username"}},"title":"LinkedServiceJobsUsersModificationHistoryFilter","type":"object","description":"LinkedServiceJobsUsersModificationHistoryFilter"},"LinkedServiceJobsSort":{"properties":{"lastModified":{"enum":["ASC","DESC"],"type":"string"},"targetTime":{"enum":["ASC","DESC"],"type":"string"}},"title":"LinkedServiceJobsSort","type":"object","description":"LinkedServiceJobsSort"},"LinkedServiceJobsPaginatedResult":{"properties":{"linkedServiceJobs":{"items":{"$ref":"#/components/schemas/LinkedServiceJobs"},"type":"array"},"pageInfo":{"allOf":[{"$ref":"#/components/schemas/PageInfo"}],"description":"Pagination information for the search result."},"total":{"description":"The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.","minimum":0,"type":"number"}},"required":["pageInfo","linkedServiceJobs"],"title":"LinkedServiceJobsPaginatedResult","type":"object","description":"LinkedServiceJobsPaginatedResult"},"LinkedServiceJobs":{"properties":{"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"facilityRef":{"description":"Id linked Facility from the includes service jobs","minLength":1,"type":"string"},"fullIdentifier":{"description":"Full identifier of the service job. Using the full name of the customer when created from an order.","minLength":1,"type":"string"},"id":{"description":"Unique ID of this linked service jobs group","minLength":1,"type":"string"},"includedServiceJobLinkIds":{"description":"searchable field of all included service job link ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"includedServiceJobRefs":{"description":"searchable field of all included service job ids","items":{"type":"string"},"maxItems":500,"minItems":1,"type":"array"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this linked service jobs group belongs to","minLength":1,"type":"string"},"processRef":{"description":"ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process","minLength":1,"type":"string"},"serviceJobLinks":{"description":"Chain of service job links representing the execution order","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":1,"type":"array"},"status":{"description":"Current status of this linked service jobs group","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","OBSOLETE","NOT_READY"],"type":"string"},"targetTime":{"description":"Target time by which all linked service jobs are expected to be completed","format":"date-time","type":"string"},"usersModificationHistory":{"items":{"$ref":"#/components/schemas/UserModificationHistory"},"maxItems":500,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["created","lastModified","version","id","processRef","facilityRef","targetTime","includedServiceJobLinkIds","includedServiceJobRefs","status","serviceJobLinks"],"title":"LinkedServiceJobs","type":"object","description":"LinkedServiceJobs"},"ServiceJobLink":{"properties":{"id":{"description":"Unique ID of this service job link","minLength":1,"type":"string"},"nextServiceJobLinks":{"description":"Links to the next service jobs in the execution chain","items":{"$ref":"#/components/schemas/ServiceJobLink"},"maxItems":50,"minItems":0,"type":"array"},"previousServiceJobLinkRefs":{"description":"id of the created previous service job links","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"previousServiceJobRefs":{"description":"IDs of the preceding service job links that must be completed before this one","items":{"type":"string"},"maxItems":1,"minItems":0,"type":"array"},"serviceJobRef":{"description":"ID of the service job this link references","minLength":1,"type":"string"}},"required":["serviceJobRef","previousServiceJobRefs","nextServiceJobLinks","id","previousServiceJobLinkRefs"],"title":"ServiceJobLink","type":"object","description":"ServiceJobLink"},"UserModificationHistory":{"additionalProperties":false,"properties":{"modificationDate":{"format":"date-time","type":"string"},"userId":{"description":"ID of the user who commited this modification","type":"string"},"username":{"description":"Username of the user who commited this modification","type":"string"}},"required":["modificationDate","username"],"type":"object","title":"UserModificationHistory","description":"UserModificationHistory"},"PageInfo":{"properties":{"endCursor":{"description":"The cursor to use to fetch the next page of items. Use with parameter `after`.","type":"string"},"hasNextPage":{"description":"If true, there are more items after the current page.","type":"boolean"},"hasPreviousPage":{"description":"If true, there are more items before the current page.","type":"boolean"},"startCursor":{"description":"The cursor to use to fetch the previous page of items.","type":"string"}},"required":["hasNextPage","hasPreviousPage","startCursor","endCursor"],"title":"PageInfo","type":"object","description":"PageInfo"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/linkedservicejobs/search":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Search for LinkedServiceJobs","operationId":"searchLinkedServiceJobs","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedServiceJobsSearchPayload"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkedServiceJobsPaginatedResult"}}},"description":"Your search result"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List linked service jobs (search)","tags":["Services (Operations)"]}}}}
```

## List service containers

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Gets service containers filtered

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServiceContainers":{"properties":{"serviceContainers":{"description":"List of service containers matching the query","items":{"$ref":"#/components/schemas/ServiceContainer"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"title":"ServiceContainers","type":"object","description":"ServiceContainers"},"ServiceContainer":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","type":"object"},"description":{"description":"Translated description, filled on request based on descriptionLocalized.","minLength":1,"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"facilityRef":{"description":"Id of the facility this container is used in.","minLength":1,"type":"string"},"iconUrl":{"description":"URL to an icon representing this container type.","minLength":1,"type":"string"},"id":{"description":"The id of this entity. It is generated during creation automatically and suits as the primary identifier of the described entity.","minLength":1,"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items contained in this service container","items":{"$ref":"#/components/schemas/ServiceContainerLineItem"},"maxItems":50,"type":"array"},"name":{"description":"Translated name, filled on request based on nameLocalized.","minLength":1,"type":"string"},"operativeContainerTypeRef":{"description":"Reference to the operative container type this container is based on.","minLength":1,"type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"scannableCodes":{"description":"Codes that can be used for scanning this container.","items":{"type":"string"},"maxItems":50,"type":"array"},"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","type":"integer"},"serviceJobRefs":{"description":"Ids of the ServiceJobs this container belongs to.","items":{"type":"string"},"maxItems":50,"type":"array"},"stackRef":{"description":"Reference to related stack","minLength":1,"type":"string"},"storageLocationRef":{"description":"Id of the storage location this container is located at.","minLength":1,"type":"string"},"type":{"description":"Type of this service container","enum":["VIRTUAL","PHYSICAL"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"weightLimitInG":{"description":"Weight limit of the container in grams.","minimum":0,"type":"integer"}},"required":["serviceJobRefs","lineItems","nameLocalized","created","lastModified","version","id","facilityRef","type"],"title":"ServiceContainer","type":"object","description":"ServiceContainer"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ServiceContainerLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"Cross-entity identifier linking this line item back to the originating pick line item.","minLength":1,"type":"string"},"id":{"description":"id line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the items, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":50,"type":"array"}},"required":["article","globalLineItemId","quantity","id"],"title":"ServiceContainerLineItem","type":"object","description":"ServiceContainerLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in the fulfillmenttools platform in order to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients. Details about usage can be found <a href=\\\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes\">here</a>","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"customAttributes":{"deprecated":true,"description":"deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/servicecontainers":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Gets service containers filtered","operationId":"getServiceContainers","parameters":[{"description":"number of entities to show","in":"query","name":"size","required":true,"schema":{"default":25,"maximum":500,"minimum":1,"type":"integer"}},{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"sorting for the results","in":"query","name":"orderBy","required":false,"schema":{"enum":["SERVICE_CONTAINER_LAST_MODIFIED_ASC","SERVICE_CONTAINER_LAST_MODIFIED_DESC","SERVICE_CONTAINER_CREATED_ASC","SERVICE_CONTAINER_CREATED_DESC"],"type":"string"}},{"description":"Reference of the facility you want to filter for","in":"query","name":"facilityRefs","required":false,"schema":{"items":{"type":"string"},"maxItems":50,"type":"array"}},{"description":"Reference of the service job you want to filter for","in":"query","name":"serviceJobRef","required":false,"schema":{"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceContainers"}}},"description":"Service containers can be found in response body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List service containers","tags":["Services (Operations)"]}}}}
```

## Create service container

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Creates a service container

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServiceContainerForCreation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"customAttributes":{"description":"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.","type":"object"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"iconUrl":{"description":"URL to an icon representing this container type.","minLength":1,"type":"string"},"lineItems":{"description":"Items contained in this service container","items":{"$ref":"#/components/schemas/ServiceContainerLineItemForCreation"},"maxItems":50,"type":"array"},"operativeContainerTypeRef":{"description":"Reference to the operative container type this container is based on.","minLength":1,"type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"scannableCodes":{"description":"Codes that can be used for scanning this container.","items":{"type":"string"},"maxItems":50,"type":"array"},"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","type":"integer"},"serviceJobRefs":{"description":"Ids of the ServiceJobs this container belongs to.","items":{"type":"string"},"maxItems":50,"type":"array"},"stackRef":{"description":"Reference to related stack","minLength":1,"type":"string"},"storageLocationRef":{"description":"Id of the storage location this container is located at.","minLength":1,"type":"string"},"weightLimitInG":{"description":"Weight limit of the container in grams.","minimum":0,"type":"integer"}},"required":["serviceJobRefs","lineItems"],"title":"ServiceContainerForCreation","type":"object","description":"ServiceContainerForCreation"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ServiceContainerLineItemForCreation":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened.","minLength":1,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"secondary quantity of this item, E.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":50,"type":"array"}},"required":["article","quantity"],"title":"ServiceContainerLineItemForCreation","type":"object","description":"ServiceContainerLineItemForCreation"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in the fulfillmenttools platform in order to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients. Details about usage can be found <a href=\\\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes\">here</a>","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"customAttributes":{"deprecated":true,"description":"deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"ServiceContainer":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","type":"object"},"description":{"description":"Translated description, filled on request based on descriptionLocalized.","minLength":1,"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"facilityRef":{"description":"Id of the facility this container is used in.","minLength":1,"type":"string"},"iconUrl":{"description":"URL to an icon representing this container type.","minLength":1,"type":"string"},"id":{"description":"The id of this entity. It is generated during creation automatically and suits as the primary identifier of the described entity.","minLength":1,"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items contained in this service container","items":{"$ref":"#/components/schemas/ServiceContainerLineItem"},"maxItems":50,"type":"array"},"name":{"description":"Translated name, filled on request based on nameLocalized.","minLength":1,"type":"string"},"operativeContainerTypeRef":{"description":"Reference to the operative container type this container is based on.","minLength":1,"type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"scannableCodes":{"description":"Codes that can be used for scanning this container.","items":{"type":"string"},"maxItems":50,"type":"array"},"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","type":"integer"},"serviceJobRefs":{"description":"Ids of the ServiceJobs this container belongs to.","items":{"type":"string"},"maxItems":50,"type":"array"},"stackRef":{"description":"Reference to related stack","minLength":1,"type":"string"},"storageLocationRef":{"description":"Id of the storage location this container is located at.","minLength":1,"type":"string"},"type":{"description":"Type of this service container","enum":["VIRTUAL","PHYSICAL"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"weightLimitInG":{"description":"Weight limit of the container in grams.","minimum":0,"type":"integer"}},"required":["serviceJobRefs","lineItems","nameLocalized","created","lastModified","version","id","facilityRef","type"],"title":"ServiceContainer","type":"object","description":"ServiceContainer"},"ServiceContainerLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"Cross-entity identifier linking this line item back to the originating pick line item.","minLength":1,"type":"string"},"id":{"description":"id line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the items, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":50,"type":"array"}},"required":["article","globalLineItemId","quantity","id"],"title":"ServiceContainerLineItem","type":"object","description":"ServiceContainerLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/servicecontainers":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Creates a service container","operationId":"createServiceContainer","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceContainerForCreation"}}},"description":"Desired service container to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceContainer"}}},"description":"The service container was successfully created."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Create service container","tags":["Services (Operations)"]}}}}
```

## Get service container by id

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Gets service container by id

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServiceContainer":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","type":"object"},"description":{"description":"Translated description, filled on request based on descriptionLocalized.","minLength":1,"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"facilityRef":{"description":"Id of the facility this container is used in.","minLength":1,"type":"string"},"iconUrl":{"description":"URL to an icon representing this container type.","minLength":1,"type":"string"},"id":{"description":"The id of this entity. It is generated during creation automatically and suits as the primary identifier of the described entity.","minLength":1,"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items contained in this service container","items":{"$ref":"#/components/schemas/ServiceContainerLineItem"},"maxItems":50,"type":"array"},"name":{"description":"Translated name, filled on request based on nameLocalized.","minLength":1,"type":"string"},"operativeContainerTypeRef":{"description":"Reference to the operative container type this container is based on.","minLength":1,"type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"scannableCodes":{"description":"Codes that can be used for scanning this container.","items":{"type":"string"},"maxItems":50,"type":"array"},"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","type":"integer"},"serviceJobRefs":{"description":"Ids of the ServiceJobs this container belongs to.","items":{"type":"string"},"maxItems":50,"type":"array"},"stackRef":{"description":"Reference to related stack","minLength":1,"type":"string"},"storageLocationRef":{"description":"Id of the storage location this container is located at.","minLength":1,"type":"string"},"type":{"description":"Type of this service container","enum":["VIRTUAL","PHYSICAL"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"weightLimitInG":{"description":"Weight limit of the container in grams.","minimum":0,"type":"integer"}},"required":["serviceJobRefs","lineItems","nameLocalized","created","lastModified","version","id","facilityRef","type"],"title":"ServiceContainer","type":"object","description":"ServiceContainer"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ServiceContainerLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"Cross-entity identifier linking this line item back to the originating pick line item.","minLength":1,"type":"string"},"id":{"description":"id line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the items, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":50,"type":"array"}},"required":["article","globalLineItemId","quantity","id"],"title":"ServiceContainerLineItem","type":"object","description":"ServiceContainerLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in the fulfillmenttools platform in order to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients. Details about usage can be found <a href=\\\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes\">here</a>","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"customAttributes":{"deprecated":true,"description":"deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/servicecontainers/{serviceContainerId}":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Gets service container by id","operationId":"getServiceContainerById","parameters":[{"description":"ID of the service container to retrieve","in":"path","name":"serviceContainerId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceContainer"}}},"description":"Service container for the given id."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get service container by id","tags":["Services (Operations)"]}}}}
```

## Delete service container

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Deletes service container by id

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/servicecontainers/{serviceContainerId}":{"delete":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Deletes service container by id","operationId":"deleteServiceContainer","parameters":[{"description":"ID of the service container to delete","in":"path","name":"serviceContainerId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The service container was successfully deleted."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Delete service container","tags":["Services (Operations)"]}}}}
```

## List service jobs

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />List service jobs

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServiceJobs":{"properties":{"serviceJobs":{"description":"List of service jobs matching the query","items":{"$ref":"#/components/schemas/ServiceJobWithSearchPaths"},"maxItems":500,"type":"array"},"total":{"description":"Total number of found entities for this query","type":"integer"}},"title":"ServiceJobs","type":"object","description":"ServiceJobs"},"ServiceJobWithSearchPaths":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"additionalInformation":{"description":"Additional information collected for this service job","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformation"},"maxItems":15,"type":"array"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":10,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","type":"object"},"customServiceRef":{"description":"Id of the customService this ServiceJob was created from.","type":"string"},"description":{"description":"Translated description of this service job derived from descriptionLocalized","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"executionTimeInMin":{"description":"Time in minutes this service job is expected to take to be executed","minimum":0,"type":"integer"},"facilityRef":{"description":"ID of the Facility, the Service Job is executed in.","type":"string"},"id":{"description":"Unique ID of this service job","minLength":1,"type":"string"},"imageRefs":{"description":"List of linked images taken from the connected custom service","items":{"type":"string"},"maxItems":50,"type":"array"},"inheritedLineItems":{"deprecated":true,"description":"deprecated: use availableLineItems on ServiceData instead","items":{"$ref":"#/components/schemas/InheritedServiceJobLineItem"},"maxItems":200,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing this service job","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items worked on in this service job are returnable after execution","type":"boolean"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items to be processed as part of this service job","items":{"$ref":"#/components/schemas/ServiceJobLineItem"},"maxItems":50,"type":"array"},"linkedServiceJobsRef":{"description":"ID of the Linked Service Job, the Service Job should reference.","type":"string"},"name":{"description":"Translated name of this service job derived from nameLocalized","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this service job is part of","type":"string"},"processRef":{"description":"ID of the process this service job belongs to","type":"string"},"requiredLineItems":{"description":"Information about the items that are required","items":{"$ref":"#/components/schemas/RequiredLineItem"},"maxItems":50,"type":"array"},"searchPaths":{"description":"Search paths used for full-text search indexing of this entity","items":{"type":"string"},"maxItems":200,"type":"array"},"serviceJobLinkRef":{"description":"ID of the Service Job Link, the Service Job should reference.","type":"string"},"shortId":{"description":"Short human-readable identifier for this service job","type":"string"},"status":{"description":"Current status of this service job","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"statusInformation":{"allOf":[{"$ref":"#/components/schemas/ServiceJobStatusInformation"}],"description":"Additional information about the current status of this service job"},"subStatus":{"description":"Additional sub-status information about this service job","enum":["LINE_ITEMS_MISSING","REQUIRED_LINE_ITEMS_UNFULFILLABLE"],"type":"string"},"targetTime":{"description":"At which time the service job is expected to be finished.","format":"date-time","type":"string"},"tenantCustomServiceId":{"description":"Tenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.","type":"string"},"tenantOrderId":{"description":"ID of the tenant order, the linked service jobs are part of","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["customServiceRef","processRef","facilityRef","lineItems","targetTime","created","lastModified","version","id","status","nameLocalized","itemsRequired","searchPaths"],"title":"ServiceJobWithSearchPaths","type":"object","description":"ServiceJobWithSearchPaths"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ServiceJobAdditionalInformation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Translated description of this additional information","minLength":1,"type":"string"},"id":{"description":"Unique ID of this additional information entry","minLength":1,"type":"string"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"name":{"description":"Translated name of this additional information","minLength":1,"type":"string"},"tenantAdditionalInformationId":{"description":"External ID referencing this additional information in the tenant system","minLength":1,"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"},"valueType":{"description":"Type of the value stored in this additional information","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType","id"],"title":"ServiceJobAdditionalInformation","type":"object","description":"ServiceJobAdditionalInformation"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"InheritedServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this inherited line item"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Unique ID of this inherited line item","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"serviceJobRef":{"description":"Reference to the service job this line item was inherited from","minLength":1,"type":"string"}},"required":["id","article","quantity","serviceJobRef"],"title":"InheritedServiceJobLineItem","type":"object","description":"InheritedServiceJobLineItem"},"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this line item"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Unique ID of this line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"ServiceJobLineItem","type":"object","description":"ServiceJobLineItem"},"RequiredLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information of the required item"},"assignedItems":{"description":"line items that have been assigned from the matching service data object","items":{"$ref":"#/components/schemas/AssignedRequiredLineItem"},"maxItems":50,"type":"array"},"id":{"description":"Unique ID of the required line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Needed quantity of the items","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"}},"required":["id","article","quantity"],"title":"RequiredLineItem","type":"object","description":"RequiredLineItem"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"AssignedRequiredLineItem":{"properties":{"quantity":{"description":"Id matching service data line item where this assigned required line item is assigned from","minimum":0,"type":"integer"},"serviceDataLineItemId":{"description":"assigned quantity of the items","minimum":0,"minLength":1,"type":"string"}},"required":["quantity","serviceDataLineItemId"],"title":"AssignedRequiredLineItem","type":"object","description":"AssignedRequiredLineItem"},"ServiceJobStatusInformation":{"properties":{"cancelReason":{"allOf":[{"$ref":"#/components/schemas/StatusReason"}],"description":"Reason provided when this service job was cancelled"}},"title":"ServiceJobStatusInformation","type":"object","description":"ServiceJobStatusInformation"},"StatusReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"translated reason selected from reasonLocalized","minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"StatusReason","type":"object","description":"StatusReason"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/servicejobs":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />List service jobs","operationId":"getServiceJobs","parameters":[{"description":"number of entities to show","in":"query","name":"size","required":false,"schema":{"default":25,"maximum":500,"minimum":1,"type":"integer"}},{"description":"all entities after given Id","in":"query","name":"startAfterId","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"Reference of the facility you want to filter for","in":"query","name":"facilityRef","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"Reference to the statuses you want to get the corresponding service job","in":"query","name":"status","required":false,"schema":{"items":{"enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"maxItems":10,"type":"array"}},{"description":"Type of channel you want to filter for","in":"query","name":"channel","required":false,"schema":{"enum":["COLLECT","SHIPPING"],"type":"string"}},{"description":"Start target date range for service jobs","in":"query","name":"startTargetTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"End target date range for service jobs","in":"query","name":"endTargetTime","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Order in which the result should be returned","in":"query","name":"orderBy","required":false,"schema":{"enum":["TARGET_TIME_ASC","TARGET_TIME_DESC","LAST_MODIFIED_ASC","LAST_MODIFIED_DESC"],"type":"string"}},{"description":"Search term you want to get the corresponding service jobs. Search will be performed on multiple fields, like tenantOrderId, consumerName, tenantArticleId and more","in":"query","name":"searchTerm","required":false,"schema":{"minLength":1,"type":"string"}},{"description":"Reference the assigned user on this entity - id or username","in":"query","name":"assignedUser","required":false,"schema":{"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceJobs"}}},"description":"Service Jobs can be found in response body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"List service jobs","tags":["Services (Operations)"]}}}}
```

## Create service job

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Create service job

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServiceJobForCreation":{"properties":{"additionalInformation":{"description":"Additional information to be collected for this service job","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformationForCreation"},"maxItems":15,"type":"array"},"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"maxItems":10,"type":"array"},"customAttributes":{"description":"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.","type":"object"},"customServiceRef":{"description":"ID of the Custom Service, the Service Job should reference. Either this and/or the tenantCustomServiceId must passed.","type":"string"},"facilityRef":{"description":"ID of the Facility, the Service Job is executed in.","type":"string"},"lineItems":{"description":"Items to be processed as part of this service job","items":{"$ref":"#/components/schemas/ServiceJobLineItemForCreation"},"maxItems":50,"type":"array"},"operativeProcessRef":{"description":"Reference to the operative process this service job is part of","type":"string"},"processRef":{"description":"ID of the Process, the Service Job belongs to.","type":"string"},"requiredLineItems":{"description":"Information about the items that are required","items":{"$ref":"#/components/schemas/RequiredLineItemForCreation"},"maxItems":50,"type":"array"},"serviceJobLinkRef":{"description":"ID of the Service Job Link, the Service Job should reference.","type":"string"},"shortId":{"description":"Short human-readable identifier for this service job","type":"string"},"targetTime":{"description":"At which time the service job is expected to be finished.","format":"date-time","type":"string"},"tenantCustomServiceId":{"description":"Tenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.","type":"string"},"tenantOrderId":{"description":"ID of the tenant order, the linked service jobs are part of","type":"string"}},"required":["facilityRef","targetTime"],"title":"ServiceJobForCreation","type":"object","description":"ServiceJobForCreation"},"ServiceJobAdditionalInformationForCreation":{"properties":{"additionalInformationRef":{"description":"ID of the additional information. Either tenantAdditionalInformationId or additionalInformationRef must be set.","minLength":1,"type":"string"},"tenantAdditionalInformationRef":{"description":"external ID of the additional information. Either tenantAdditionalInformationId or additionalInformationRef must be set.","minLength":1,"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"}},"title":"ServiceJobAdditionalInformationForCreation","type":"object","description":"ServiceJobAdditionalInformationForCreation"},"AssignedUserForCreationByName":{"description":"Create a assigned user by giving a valid name","properties":{"username":{"description":"username of the user should be assigned","type":"string"}},"required":["username"],"title":"AssignedUserForCreationByName","type":"object"},"AssignedUserForCreationById":{"description":"Create a assigned user by giving a valid id","properties":{"userId":{"description":"userId of the user should be assigned","type":"string"}},"required":["userId"],"title":"AssignedUserForCreationById","type":"object"},"ServiceJobLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this line item"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"title":"ServiceJobLineItemForCreation","type":"object","description":"ServiceJobLineItemForCreation"},"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"RequiredLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information of the required item"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Needed quantity of the items","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"}},"required":["article","quantity"],"title":"RequiredLineItemForCreation","type":"object","description":"RequiredLineItemForCreation"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"ServiceJob":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"additionalInformation":{"description":"Additional information collected for this service job","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformation"},"maxItems":15,"type":"array"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":10,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","type":"object"},"customServiceRef":{"description":"Id of the customService this ServiceJob was created from.","type":"string"},"description":{"description":"Translated description of this service job derived from descriptionLocalized","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"executionTimeInMin":{"description":"Time in minutes this service job is expected to take to be executed","minimum":0,"type":"integer"},"facilityRef":{"description":"ID of the Facility, the Service Job is executed in.","type":"string"},"id":{"description":"Unique ID of this service job","minLength":1,"type":"string"},"imageRefs":{"description":"List of linked images taken from the connected custom service","items":{"type":"string"},"maxItems":50,"type":"array"},"inheritedLineItems":{"deprecated":true,"description":"deprecated: use availableLineItems on ServiceData instead","items":{"$ref":"#/components/schemas/InheritedServiceJobLineItem"},"maxItems":200,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing this service job","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items worked on in this service job are returnable after execution","type":"boolean"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items to be processed as part of this service job","items":{"$ref":"#/components/schemas/ServiceJobLineItem"},"maxItems":50,"type":"array"},"linkedServiceJobsRef":{"description":"ID of the Linked Service Job, the Service Job should reference.","type":"string"},"name":{"description":"Translated name of this service job derived from nameLocalized","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this service job is part of","type":"string"},"processRef":{"description":"ID of the process this service job belongs to","type":"string"},"requiredLineItems":{"description":"Information about the items that are required","items":{"$ref":"#/components/schemas/RequiredLineItem"},"maxItems":50,"type":"array"},"serviceJobLinkRef":{"description":"ID of the Service Job Link, the Service Job should reference.","type":"string"},"shortId":{"description":"Short human-readable identifier for this service job","type":"string"},"status":{"description":"Current status of this service job","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"statusInformation":{"allOf":[{"$ref":"#/components/schemas/ServiceJobStatusInformation"}],"description":"Additional information about the current status of this service job"},"subStatus":{"description":"Additional sub-status information about this service job","enum":["LINE_ITEMS_MISSING","REQUIRED_LINE_ITEMS_UNFULFILLABLE"],"type":"string"},"targetTime":{"description":"At which time the service job is expected to be finished.","format":"date-time","type":"string"},"tenantCustomServiceId":{"description":"Tenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.","type":"string"},"tenantOrderId":{"description":"ID of the tenant order, the linked service jobs are part of","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["customServiceRef","processRef","facilityRef","lineItems","targetTime","created","lastModified","version","id","status","nameLocalized","itemsRequired"],"title":"ServiceJob","type":"object","description":"ServiceJob"},"ServiceJobAdditionalInformation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Translated description of this additional information","minLength":1,"type":"string"},"id":{"description":"Unique ID of this additional information entry","minLength":1,"type":"string"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"name":{"description":"Translated name of this additional information","minLength":1,"type":"string"},"tenantAdditionalInformationId":{"description":"External ID referencing this additional information in the tenant system","minLength":1,"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"},"valueType":{"description":"Type of the value stored in this additional information","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType","id"],"title":"ServiceJobAdditionalInformation","type":"object","description":"ServiceJobAdditionalInformation"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"InheritedServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this inherited line item"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Unique ID of this inherited line item","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"serviceJobRef":{"description":"Reference to the service job this line item was inherited from","minLength":1,"type":"string"}},"required":["id","article","quantity","serviceJobRef"],"title":"InheritedServiceJobLineItem","type":"object","description":"InheritedServiceJobLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this line item"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Unique ID of this line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"ServiceJobLineItem","type":"object","description":"ServiceJobLineItem"},"RequiredLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information of the required item"},"assignedItems":{"description":"line items that have been assigned from the matching service data object","items":{"$ref":"#/components/schemas/AssignedRequiredLineItem"},"maxItems":50,"type":"array"},"id":{"description":"Unique ID of the required line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Needed quantity of the items","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"}},"required":["id","article","quantity"],"title":"RequiredLineItem","type":"object","description":"RequiredLineItem"},"AssignedRequiredLineItem":{"properties":{"quantity":{"description":"Id matching service data line item where this assigned required line item is assigned from","minimum":0,"type":"integer"},"serviceDataLineItemId":{"description":"assigned quantity of the items","minimum":0,"minLength":1,"type":"string"}},"required":["quantity","serviceDataLineItemId"],"title":"AssignedRequiredLineItem","type":"object","description":"AssignedRequiredLineItem"},"ServiceJobStatusInformation":{"properties":{"cancelReason":{"allOf":[{"$ref":"#/components/schemas/StatusReason"}],"description":"Reason provided when this service job was cancelled"}},"title":"ServiceJobStatusInformation","type":"object","description":"ServiceJobStatusInformation"},"StatusReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"translated reason selected from reasonLocalized","minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"StatusReason","type":"object","description":"StatusReason"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/servicejobs":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Create service job","operationId":"createServiceJob","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceJobForCreation"}}},"description":"Desired service job to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceJob"}}},"description":"The service job was successfully created."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Create service job","tags":["Services (Operations)"]}}}}
```

## Get service job

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Get service job

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServiceJob":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"additionalInformation":{"description":"Additional information collected for this service job","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformation"},"maxItems":15,"type":"array"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":10,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","type":"object"},"customServiceRef":{"description":"Id of the customService this ServiceJob was created from.","type":"string"},"description":{"description":"Translated description of this service job derived from descriptionLocalized","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"executionTimeInMin":{"description":"Time in minutes this service job is expected to take to be executed","minimum":0,"type":"integer"},"facilityRef":{"description":"ID of the Facility, the Service Job is executed in.","type":"string"},"id":{"description":"Unique ID of this service job","minLength":1,"type":"string"},"imageRefs":{"description":"List of linked images taken from the connected custom service","items":{"type":"string"},"maxItems":50,"type":"array"},"inheritedLineItems":{"deprecated":true,"description":"deprecated: use availableLineItems on ServiceData instead","items":{"$ref":"#/components/schemas/InheritedServiceJobLineItem"},"maxItems":200,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing this service job","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items worked on in this service job are returnable after execution","type":"boolean"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items to be processed as part of this service job","items":{"$ref":"#/components/schemas/ServiceJobLineItem"},"maxItems":50,"type":"array"},"linkedServiceJobsRef":{"description":"ID of the Linked Service Job, the Service Job should reference.","type":"string"},"name":{"description":"Translated name of this service job derived from nameLocalized","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this service job is part of","type":"string"},"processRef":{"description":"ID of the process this service job belongs to","type":"string"},"requiredLineItems":{"description":"Information about the items that are required","items":{"$ref":"#/components/schemas/RequiredLineItem"},"maxItems":50,"type":"array"},"serviceJobLinkRef":{"description":"ID of the Service Job Link, the Service Job should reference.","type":"string"},"shortId":{"description":"Short human-readable identifier for this service job","type":"string"},"status":{"description":"Current status of this service job","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"statusInformation":{"allOf":[{"$ref":"#/components/schemas/ServiceJobStatusInformation"}],"description":"Additional information about the current status of this service job"},"subStatus":{"description":"Additional sub-status information about this service job","enum":["LINE_ITEMS_MISSING","REQUIRED_LINE_ITEMS_UNFULFILLABLE"],"type":"string"},"targetTime":{"description":"At which time the service job is expected to be finished.","format":"date-time","type":"string"},"tenantCustomServiceId":{"description":"Tenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.","type":"string"},"tenantOrderId":{"description":"ID of the tenant order, the linked service jobs are part of","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["customServiceRef","processRef","facilityRef","lineItems","targetTime","created","lastModified","version","id","status","nameLocalized","itemsRequired"],"title":"ServiceJob","type":"object","description":"ServiceJob"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ServiceJobAdditionalInformation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Translated description of this additional information","minLength":1,"type":"string"},"id":{"description":"Unique ID of this additional information entry","minLength":1,"type":"string"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"name":{"description":"Translated name of this additional information","minLength":1,"type":"string"},"tenantAdditionalInformationId":{"description":"External ID referencing this additional information in the tenant system","minLength":1,"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"},"valueType":{"description":"Type of the value stored in this additional information","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType","id"],"title":"ServiceJobAdditionalInformation","type":"object","description":"ServiceJobAdditionalInformation"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"InheritedServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this inherited line item"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Unique ID of this inherited line item","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"serviceJobRef":{"description":"Reference to the service job this line item was inherited from","minLength":1,"type":"string"}},"required":["id","article","quantity","serviceJobRef"],"title":"InheritedServiceJobLineItem","type":"object","description":"InheritedServiceJobLineItem"},"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this line item"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Unique ID of this line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"ServiceJobLineItem","type":"object","description":"ServiceJobLineItem"},"RequiredLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information of the required item"},"assignedItems":{"description":"line items that have been assigned from the matching service data object","items":{"$ref":"#/components/schemas/AssignedRequiredLineItem"},"maxItems":50,"type":"array"},"id":{"description":"Unique ID of the required line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Needed quantity of the items","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"}},"required":["id","article","quantity"],"title":"RequiredLineItem","type":"object","description":"RequiredLineItem"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"AssignedRequiredLineItem":{"properties":{"quantity":{"description":"Id matching service data line item where this assigned required line item is assigned from","minimum":0,"type":"integer"},"serviceDataLineItemId":{"description":"assigned quantity of the items","minimum":0,"minLength":1,"type":"string"}},"required":["quantity","serviceDataLineItemId"],"title":"AssignedRequiredLineItem","type":"object","description":"AssignedRequiredLineItem"},"ServiceJobStatusInformation":{"properties":{"cancelReason":{"allOf":[{"$ref":"#/components/schemas/StatusReason"}],"description":"Reason provided when this service job was cancelled"}},"title":"ServiceJobStatusInformation","type":"object","description":"ServiceJobStatusInformation"},"StatusReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"translated reason selected from reasonLocalized","minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"StatusReason","type":"object","description":"StatusReason"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/servicejobs/{serviceJobId}":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Get service job","operationId":"getServiceJob","parameters":[{"description":"ID of service job you want to get","in":"path","name":"serviceJobId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceJob"}}},"description":"Service Job can be found in response body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get service job","tags":["Services (Operations)"]}}}}
```

## Call service job action

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Apply an action to a service job.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServiceJobInProgressActionParameter":{"properties":{"additionalInformation":{"description":"Additional information updates to apply along with the action","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformationForUpdate"},"maxItems":15,"type":"array"},"name":{"description":"Name of the action to perform, must be 'StartServiceJob'","enum":["StartServiceJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"ServiceJobInProgressActionParameter","type":"object","description":"ServiceJobInProgressActionParameter"},"ServiceJobAdditionalInformationForUpdate":{"properties":{"additionalInformationRef":{"description":"ID of the additional information","type":"string"},"tenantAdditionalInformationRef":{"description":"external ID of the additional information","type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"}},"title":"ServiceJobAdditionalInformationForUpdate","type":"object","description":"ServiceJobAdditionalInformationForUpdate"},"ServiceJobFinishedActionParameter":{"properties":{"additionalInformation":{"description":"Additional information updates to apply along with the action","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformationForUpdate"},"maxItems":15,"type":"array"},"name":{"description":"Name of the action to perform, must be 'FinishServiceJob'","enum":["FinishServiceJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"ServiceJobFinishedActionParameter","type":"object","description":"ServiceJobFinishedActionParameter"},"ServiceJobCancelledActionParameter":{"properties":{"additionalInformation":{"description":"Additional information updates to apply along with the action","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformationForUpdate"},"maxItems":15,"type":"array"},"cancelReason":{"$ref":"#/components/schemas/LocaleString"},"name":{"description":"Name of the action to perform, must be 'CancelServiceJob'","enum":["CancelServiceJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"ServiceJobCancelledActionParameter","type":"object","description":"ServiceJobCancelledActionParameter"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ServiceJobWaitingForInputActionParameter":{"properties":{"additionalInformation":{"description":"Additional information updates to apply along with the action","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformationForUpdate"},"maxItems":15,"type":"array"},"name":{"description":"Name of the action to perform, must be 'HoldServiceJob'","enum":["HoldServiceJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"ServiceJobWaitingForInputActionParameter","type":"object","description":"ServiceJobWaitingForInputActionParameter"},"ServiceJobOpenActionParameter":{"properties":{"additionalInformation":{"description":"Additional information updates to apply along with the action","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformationForUpdate"},"maxItems":15,"type":"array"},"name":{"description":"Name of the action to perform, must be 'OpenServiceJob'","enum":["OpenServiceJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"ServiceJobOpenActionParameter","type":"object","description":"ServiceJobOpenActionParameter"},"ServiceJobObsoleteActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'ObsoleteServiceJob'","enum":["ObsoleteServiceJob"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version"],"title":"ServiceJobObsoleteActionParameter","type":"object","description":"ServiceJobObsoleteActionParameter"},"ServiceJobReplaceAssignedUsersActionParameter":{"properties":{"assignedUsers":{"description":"Assigned users for this entity","items":{"anyOf":[{"$ref":"#/components/schemas/AssignedUserForCreationByName"},{"$ref":"#/components/schemas/AssignedUserForCreationById"}]},"maxItems":10,"type":"array"},"name":{"description":"Name of the action to perform, must be 'REPLACE_ASSIGNED_USERS'","enum":["REPLACE_ASSIGNED_USERS"],"type":"string"},"version":{"description":"Version of the entity to be changed","minimum":0,"type":"integer"}},"required":["name","version","assignedUsers"],"title":"ServiceJobReplaceAssignedUsersActionParameter","type":"object","description":"ServiceJobReplaceAssignedUsersActionParameter"},"AssignedUserForCreationByName":{"description":"Create a assigned user by giving a valid name","properties":{"username":{"description":"username of the user should be assigned","type":"string"}},"required":["username"],"title":"AssignedUserForCreationByName","type":"object"},"AssignedUserForCreationById":{"description":"Create a assigned user by giving a valid id","properties":{"userId":{"description":"userId of the user should be assigned","type":"string"}},"required":["userId"],"title":"AssignedUserForCreationById","type":"object"},"ServiceJobSplitLineItemsActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'SPLIT_LINES_SERVICE_JOB'","enum":["SPLIT_LINES_SERVICE_JOB"],"type":"string"},"splitLineItemsInfo":{"description":"List of line item splits to perform, each specifying a line item and its new quantity","items":{"$ref":"#/components/schemas/ServiceJobSplitLineItemsInfo"},"maxItems":50,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","minimum":0,"type":"integer"}},"required":["name","version","splitLineItemsInfo"],"title":"ServiceJobSplitLineItemsActionParameter","type":"object","description":"ServiceJobSplitLineItemsActionParameter"},"ServiceJobSplitLineItemsInfo":{"properties":{"lineItemId":{"description":"references the id of the lineItem of a serviceJob","type":"string"},"quantity":{"description":"quantity of the specific item that has been ordered","minimum":1,"type":"integer"}},"required":["lineItemId","quantity"],"title":"ServiceJobSplitLineItemsInfo","type":"object","description":"ServiceJobSplitLineItemsInfo"},"UpdateServiceJobLineItemRecordableAttributesActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'UPDATE_SERVICE_JOB_LINE_ITEM_RECORDABLE_ATTRIBUTES'","enum":["UPDATE_SERVICE_JOB_LINE_ITEM_RECORDABLE_ATTRIBUTES"],"type":"string"},"recordableAttributeUpdates":{"items":{"$ref":"#/components/schemas/RecordableAttributeForUpdate"},"maxItems":50,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","minimum":0,"type":"integer"}},"required":["name","version","recordableAttributeUpdates"],"title":"UpdateServiceJobLineItemRecordableAttributesActionParameter","type":"object","description":"UpdateServiceJobLineItemRecordableAttributesActionParameter"},"RecordableAttributeForUpdate":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute to set","minLength":1,"nullable":true,"type":"string"},"recordableAttributeId":{"description":"id of the recordable attribute to update","type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute to set","nullable":true,"type":"string"}},"required":["recordableAttributeId"],"title":"RecordableAttributeForUpdate","type":"object","description":"RecordableAttributeForUpdate"},"ServiceJob":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"additionalInformation":{"description":"Additional information collected for this service job","items":{"$ref":"#/components/schemas/ServiceJobAdditionalInformation"},"maxItems":15,"type":"array"},"anonymized":{"description":"Indicates if gdpr related data was anonymized","type":"boolean"},"assignedUsers":{"description":"Assigned users for this entity","items":{"$ref":"#/components/schemas/AssignedUser"},"maxItems":10,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","type":"object"},"customServiceRef":{"description":"Id of the customService this ServiceJob was created from.","type":"string"},"description":{"description":"Translated description of this service job derived from descriptionLocalized","type":"string"},"editor":{"$ref":"#/components/schemas/Editor"},"executionTimeInMin":{"description":"Time in minutes this service job is expected to take to be executed","minimum":0,"type":"integer"},"facilityRef":{"description":"ID of the Facility, the Service Job is executed in.","type":"string"},"id":{"description":"Unique ID of this service job","minLength":1,"type":"string"},"imageRefs":{"description":"List of linked images taken from the connected custom service","items":{"type":"string"},"maxItems":50,"type":"array"},"inheritedLineItems":{"deprecated":true,"description":"deprecated: use availableLineItems on ServiceData instead","items":{"$ref":"#/components/schemas/InheritedServiceJobLineItem"},"maxItems":200,"type":"array"},"itemsRequired":{"description":"Indicates whether items are required for executing this service job","enum":["MANDATORY","NONE"],"type":"string"},"itemsReturnable":{"description":"Indicates if the items worked on in this service job are returnable after execution","type":"boolean"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items to be processed as part of this service job","items":{"$ref":"#/components/schemas/ServiceJobLineItem"},"maxItems":50,"type":"array"},"linkedServiceJobsRef":{"description":"ID of the Linked Service Job, the Service Job should reference.","type":"string"},"name":{"description":"Translated name of this service job derived from nameLocalized","type":"string"},"operativeProcessRef":{"description":"Reference to the operative process this service job is part of","type":"string"},"processRef":{"description":"ID of the process this service job belongs to","type":"string"},"requiredLineItems":{"description":"Information about the items that are required","items":{"$ref":"#/components/schemas/RequiredLineItem"},"maxItems":50,"type":"array"},"serviceJobLinkRef":{"description":"ID of the Service Job Link, the Service Job should reference.","type":"string"},"shortId":{"description":"Short human-readable identifier for this service job","type":"string"},"status":{"description":"Current status of this service job","enum":["OPEN","IN_PROGRESS","FINISHED","CANCELLED","WAITING_FOR_INPUT","OBSOLETE","NOT_READY"],"type":"string"},"statusInformation":{"allOf":[{"$ref":"#/components/schemas/ServiceJobStatusInformation"}],"description":"Additional information about the current status of this service job"},"subStatus":{"description":"Additional sub-status information about this service job","enum":["LINE_ITEMS_MISSING","REQUIRED_LINE_ITEMS_UNFULFILLABLE"],"type":"string"},"targetTime":{"description":"At which time the service job is expected to be finished.","format":"date-time","type":"string"},"tenantCustomServiceId":{"description":"Tenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.","type":"string"},"tenantOrderId":{"description":"ID of the tenant order, the linked service jobs are part of","type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["customServiceRef","processRef","facilityRef","lineItems","targetTime","created","lastModified","version","id","status","nameLocalized","itemsRequired"],"title":"ServiceJob","type":"object","description":"ServiceJob"},"ServiceJobAdditionalInformation":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"description":{"description":"Translated description of this additional information","minLength":1,"type":"string"},"id":{"description":"Unique ID of this additional information entry","minLength":1,"type":"string"},"isMandatory":{"description":"Indicates if filling in this additional information is mandatory","type":"boolean"},"name":{"description":"Translated name of this additional information","minLength":1,"type":"string"},"tenantAdditionalInformationId":{"description":"External ID referencing this additional information in the tenant system","minLength":1,"type":"string"},"value":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"}],"description":"Value of the additional information"},"valueType":{"description":"Type of the value stored in this additional information","enum":["STRING","BOOLEAN","NUMBER","NOVALUE","INPUT_MULTILINE_STRING"],"type":"string"}},"required":["nameLocalized","valueType","id"],"title":"ServiceJobAdditionalInformation","type":"object","description":"ServiceJobAdditionalInformation"},"AssignedUser":{"properties":{"userId":{"description":"ID of the user who is assigned","type":"string"},"username":{"description":"username of the user who is assigned","type":"string"}},"required":["username","userId"],"type":"object","title":"AssignedUser","description":"AssignedUser"},"Editor":{"properties":{"userId":{"description":"ID of the user who edits the pickjob","type":"string"},"username":{"description":"username of the user who edits the pickjob","type":"string"}},"required":["username"],"type":"object","title":"Editor","description":"Editor"},"InheritedServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this inherited line item"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Unique ID of this inherited line item","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"},"serviceJobRef":{"description":"Reference to the service job this line item was inherited from","minLength":1,"type":"string"}},"required":["id","article","quantity","serviceJobRef"],"title":"InheritedServiceJobLineItem","type":"object","description":"InheritedServiceJobLineItem"},"ServiceJobLineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ServiceJobLineItemArticle","type":"object","description":"ServiceJobLineItemArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ServiceJobLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceJobLineItemArticle"}],"description":"Article information of this line item"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"Unique ID of this line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity"],"title":"ServiceJobLineItem","type":"object","description":"ServiceJobLineItem"},"RequiredLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information of the required item"},"assignedItems":{"description":"line items that have been assigned from the matching service data object","items":{"$ref":"#/components/schemas/AssignedRequiredLineItem"},"maxItems":50,"type":"array"},"id":{"description":"Unique ID of the required line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"quantity":{"description":"Needed quantity of the items","minimum":1,"type":"integer"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"}},"required":["id","article","quantity"],"title":"RequiredLineItem","type":"object","description":"RequiredLineItem"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"AssignedRequiredLineItem":{"properties":{"quantity":{"description":"Id matching service data line item where this assigned required line item is assigned from","minimum":0,"type":"integer"},"serviceDataLineItemId":{"description":"assigned quantity of the items","minimum":0,"minLength":1,"type":"string"}},"required":["quantity","serviceDataLineItemId"],"title":"AssignedRequiredLineItem","type":"object","description":"AssignedRequiredLineItem"},"ServiceJobStatusInformation":{"properties":{"cancelReason":{"allOf":[{"$ref":"#/components/schemas/StatusReason"}],"description":"Reason provided when this service job was cancelled"}},"title":"ServiceJobStatusInformation","type":"object","description":"ServiceJobStatusInformation"},"StatusReason":{"properties":{"reasonLocalized":{"$ref":"#/components/schemas/LocaleString"},"reason":{"description":"translated reason selected from reasonLocalized","minLength":1,"type":"string"}},"required":["reasonLocalized"],"title":"StatusReason","type":"object","description":"StatusReason"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/servicejobs/{serviceJobId}/actions":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Apply an action to a service job.","operationId":"updateServiceJob","parameters":[{"description":"ID of service job you want to update","in":"path","name":"serviceJobId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ServiceJobInProgressActionParameter"},{"$ref":"#/components/schemas/ServiceJobFinishedActionParameter"},{"$ref":"#/components/schemas/ServiceJobCancelledActionParameter"},{"$ref":"#/components/schemas/ServiceJobWaitingForInputActionParameter"},{"$ref":"#/components/schemas/ServiceJobOpenActionParameter"},{"$ref":"#/components/schemas/ServiceJobObsoleteActionParameter"},{"$ref":"#/components/schemas/ServiceJobReplaceAssignedUsersActionParameter"},{"$ref":"#/components/schemas/ServiceJobSplitLineItemsActionParameter"},{"$ref":"#/components/schemas/UpdateServiceJobLineItemRecordableAttributesActionParameter"}]}}},"description":"Desired change to a service job","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceJob"}}},"description":"The service job was successfully updated."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Call service job action","tags":["Services (Operations)"]}}}}
```

## List service containers for a service job

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Lists service containers by the id of the related service job

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServiceContainer":{"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString"},"descriptionLocalized":{"$ref":"#/components/schemas/LocaleString"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"customAttributes":{"description":"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.","type":"object"},"description":{"description":"Translated description, filled on request based on descriptionLocalized.","minLength":1,"type":"string"},"dimensions":{"$ref":"#/components/schemas/ContainerDimensions"},"facilityRef":{"description":"Id of the facility this container is used in.","minLength":1,"type":"string"},"iconUrl":{"description":"URL to an icon representing this container type.","minLength":1,"type":"string"},"id":{"description":"The id of this entity. It is generated during creation automatically and suits as the primary identifier of the described entity.","minLength":1,"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"lineItems":{"description":"Items contained in this service container","items":{"$ref":"#/components/schemas/ServiceContainerLineItem"},"maxItems":50,"type":"array"},"name":{"description":"Translated name, filled on request based on nameLocalized.","minLength":1,"type":"string"},"operativeContainerTypeRef":{"description":"Reference to the operative container type this container is based on.","minLength":1,"type":"string"},"previousModuleContainerInfo":{"$ref":"#/components/schemas/PreviousModuleContainerInfo"},"scannableCodes":{"description":"Codes that can be used for scanning this container.","items":{"type":"string"},"maxItems":50,"type":"array"},"sequenceNumber":{"description":"Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.","type":"integer"},"serviceJobRefs":{"description":"Ids of the ServiceJobs this container belongs to.","items":{"type":"string"},"maxItems":50,"type":"array"},"stackRef":{"description":"Reference to related stack","minLength":1,"type":"string"},"storageLocationRef":{"description":"Id of the storage location this container is located at.","minLength":1,"type":"string"},"type":{"description":"Type of this service container","enum":["VIRTUAL","PHYSICAL"],"type":"string"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"},"weightLimitInG":{"description":"Weight limit of the container in grams.","minimum":0,"type":"integer"}},"required":["serviceJobRefs","lineItems","nameLocalized","created","lastModified","version","id","facilityRef","type"],"title":"ServiceContainer","type":"object","description":"ServiceContainer"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ContainerDimensions":{"additionalProperties":false,"properties":{"heightInCm":{"description":"The height of the container (in cm)","type":"number"},"lengthInCm":{"description":"The length of the container (in cm)","type":"number"},"weightInG":{"description":"The weight of the container (in g)","type":"number"},"widthInCm":{"description":"The width of the container (in cm)","type":"number"}},"type":"object","title":"ContainerDimensions","description":"ContainerDimensions"},"ServiceContainerLineItem":{"properties":{"article":{"$ref":"#/components/schemas/LineItemArticle"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"globalLineItemId":{"description":"Cross-entity identifier linking this line item back to the originating pick line item.","minLength":1,"type":"string"},"id":{"description":"id line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the ‘pre-split’ status.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":1,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"},"secondaryMeasurementUnitKey":{"description":"Identifier for items unit of measurement. E.g. measurementUnitKey is pieces and secondaryMeasurementUnitKey is gram","minLength":1,"type":"string"},"secondaryQuantity":{"description":"Secondary quantity of the items, e.g. quantity is the count and secondaryQuantity is the weight","minimum":0,"type":"integer"},"stickers":{"items":{"$ref":"#/components/schemas/Sticker"},"maxItems":50,"type":"array"},"tags":{"items":{"$ref":"#/components/schemas/TagReference"},"maxItems":50,"type":"array"}},"required":["article","globalLineItemId","quantity","id"],"title":"ServiceContainerLineItem","type":"object","description":"ServiceContainerLineItem"},"LineItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"description":"Attributes are used in the fulfillmenttools platform in order to impose a certain degree of customization to a process, such as improving the appearance in the platform and clients. Details about usage can be found <a href=\\\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/customization-via-attributes\">here</a>","items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"type":"array"},"customAttributes":{"deprecated":true,"description":"deprecated: use customAttributes on lineItem instead.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["title","tenantArticleId"],"title":"LineItemArticle","type":"object","description":"LineItemArticle"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"Sticker":{"additionalProperties":false,"properties":{"nameLocalized":{"$ref":"#/components/schemas/LocaleString","description":"Dictionary of possible translations, min 1 entry, max 14 characters per description"},"color":{"description":"optional color coding for the sticker","type":"string"},"key":{"description":"unique identifier","type":"string"},"name":{"description":"Translated display name","type":"string"},"priority":{"description":"priority of the given sticker","format":"int64","maximum":10000,"minimum":1,"type":"integer"}},"required":["key","nameLocalized","priority"],"title":"Sticker","description":"Sticker"},"TagReference":{"properties":{"id":{"type":"string"},"value":{"type":"string"}},"required":["value","id"],"title":"TagReference","description":"TagReference"},"PreviousModuleContainerInfo":{"description":"This object contains information about the container from which this container was created from.","properties":{"containerRef":{"description":"The id of the previous container","type":"string"},"type":{"$ref":"#/components/schemas/PreviousModuleContainerInfoTypeEnum"}},"required":["containerRef","type"],"type":"object","title":"PreviousModuleContainerInfo"},"PreviousModuleContainerInfoTypeEnum":{"enum":["LOAD_UNIT","SERVICE_CONTAINER","PACKING_TARGET_CONTAINER"],"title":"PreviousModuleContainerInfoTypeEnum","description":"PreviousModuleContainerInfoTypeEnum"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/servicejobs/{serviceJobId}/servicecontainers":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Lists service containers by the id of the related service job","operationId":"getServiceContainersByServiceJobId","parameters":[{"description":"ID of the service job to retrieve containers for","in":"path","name":"serviceJobId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ServiceContainer"},"type":"array"}}},"description":"Service containers for the given service job."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"List service containers for a service job","tags":["Services (Operations)"]}}}}
```

## Get service data

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Get the service data of the referenced service job.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServiceData":{"properties":{"availableLineItems":{"description":"Information about the items that are available for the service job.","items":{"$ref":"#/components/schemas/ServiceDataAvailableLineItem"},"maxItems":200,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"id":{"description":"ID of the Service Data","minLength":1,"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"serviceJobRefs":{"description":"IDs of all serviceJobs connected to this service data","items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["serviceJobRefs","availableLineItems","created","lastModified","version","id"],"title":"ServiceData","type":"object","description":"ServiceData"},"ServiceDataAvailableLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information for this available line item"},"availableQuantity":{"description":"Quantity of the item that is available","minimum":0,"type":"integer"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"executedServiceJobData":{"description":"History of service jobs that have processed this available line item","items":{"$ref":"#/components/schemas/ServiceDataExecutedServiceJobs"},"maxItems":50,"type":"array"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the available line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the 'pre-split' status.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity","availableQuantity","executedServiceJobData"],"title":"ServiceDataAvailableLineItem","type":"object","description":"ServiceDataAvailableLineItem"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ServiceDataExecutedServiceJobs":{"properties":{"appliedQuantity":{"description":"Quantity of the item that has been selected from this service job","minimum":0,"type":"integer"},"itemsReturnable":{"description":"Indicates if the item is returnable based on the used service job definition while adding the items","type":"boolean"},"sequence":{"description":"sequence in which this service job has been executed for this line item. the lower, the earlier it has been executed.","minimum":1,"type":"integer"},"serviceJobRef":{"description":"Id of the Service Job, that has been applied to the ServiceDataAvailableLineItem.","minLength":1,"type":"string"}},"required":["serviceJobRef","sequence","appliedQuantity","itemsReturnable"],"title":"ServiceDataExecutedServiceJobs","type":"object","description":"ServiceDataExecutedServiceJobs"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/servicejobs/{serviceJobId}/servicedata":{"get":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Get the service data of the referenced service job.","operationId":"getServiceData","parameters":[{"description":"ID of service job referenced by the service data you want to get","in":"path","name":"serviceJobId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceData"}}},"description":"Service Data can be found in response body."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"The requested entity was not found"}},"summary":"Get service data","tags":["Services (Operations)"]}}}}
```

## Call service data action

> This part of the API is in Beta status. For details please check the \<a href="<https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta>" target="\_blank">api-release-life-cycle documentation\</a>.\<br />\<br />Apply an action to the service data of the referenced service job.

```json
{"openapi":"3.0.1","info":{"title":"fulfillmenttools","version":"VERSIONLESS"},"tags":[{"description":"Endpoints to create, update, and read operative service jobs.","name":"Services (Operations)"}],"servers":[{"url":"https://{tenant}.api.fulfillmenttools.com","variables":{"tenant":{"default":"your-tenant-name"}}}],"security":[{"BearerToken":[]}],"components":{"securitySchemes":{"BearerToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ServiceItemSelectQuantityActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'SELECT_ITEMS_FOR_SERVICE_JOB'","enum":["SELECT_ITEMS_FOR_SERVICE_JOB"],"type":"string"},"serviceItemsToSelect":{"description":"Service items that are selected to be used in the service job","items":{"$ref":"#/components/schemas/ServiceItemInfo"},"maxItems":50,"minItems":1,"type":"array"},"serviceJobVersion":{"description":"Version of the service job","minimum":0,"type":"integer"}},"required":["name","serviceItemsToSelect","serviceJobVersion"],"title":"ServiceItemSelectQuantityActionParameter","type":"object","description":"ServiceItemSelectQuantityActionParameter"},"ServiceItemInfo":{"properties":{"quantity":{"description":"Quantity of the item to be (un-)selected).","minimum":1,"type":"integer"},"serviceItemRef":{"description":"Id of the ServiceItem to be (un-)selected).","minLength":1,"type":"string"}},"required":["serviceItemRef","quantity"],"title":"ServiceItemInfo","type":"object","description":"ServiceItemInfo"},"ServiceItemUnselectQuantityActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'UNSELECT_ITEMS_FOR_SERVICE_JOB'","enum":["UNSELECT_ITEMS_FOR_SERVICE_JOB"],"type":"string"},"serviceItemsToUnselect":{"description":"Service items that are unselected from being used in the service job","items":{"$ref":"#/components/schemas/ServiceItemInfo"},"maxItems":50,"minItems":1,"type":"array"},"serviceJobVersion":{"description":"Version of the service job","minimum":0,"type":"integer"}},"required":["name","serviceItemsToUnselect","serviceJobVersion"],"title":"ServiceItemUnselectQuantityActionParameter","type":"object","description":"ServiceItemUnselectQuantityActionParameter"},"AddServiceDataAvailableLineItemsActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'ADD_SERVICE_DATA_AVAILABLE_LINE_ITEMS'","enum":["ADD_SERVICE_DATA_AVAILABLE_LINE_ITEMS"],"type":"string"},"serviceDataAvailableLineItems":{"description":"Service data available line items to be added","items":{"$ref":"#/components/schemas/ServiceDataAvailableLineItemForCreation"},"maxItems":50,"minItems":1,"type":"array"},"serviceDataVersion":{"description":"Version of the service data","minimum":0,"type":"integer"}},"required":["name","serviceDataAvailableLineItems","serviceDataVersion"],"title":"AddServiceDataAvailableLineItemsActionParameter","type":"object","description":"AddServiceDataAvailableLineItemsActionParameter"},"ServiceDataAvailableLineItemForCreation":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information for this available line item"},"availableQuantity":{"description":"Quantity of the item that is available","minimum":0,"type":"integer"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"executedServiceJobData":{"description":"History of service jobs that have processed this available line item","items":{"$ref":"#/components/schemas/ServiceDataExecutedServiceJobs"},"maxItems":50,"type":"array"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the 'pre-split' status.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","minimum":0,"type":"integer"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttributeForCreation"},"maxItems":50,"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"maxItems":50,"type":"array"}},"required":["article","quantity","availableQuantity","executedServiceJobData"],"title":"ServiceDataAvailableLineItemForCreation","type":"object","description":"ServiceDataAvailableLineItemForCreation"},"ServiceDataItemArticle":{"properties":{"titleLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the title of the product"},"attributes":{"items":{"$ref":"#/components/schemas/ArticleAttributeItem"},"maxItems":200,"type":"array"},"customAttributes":{"description":"Attributes that can be added to this entity. These attributes **cannot** be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.","nullable":true,"type":"object"},"imageUrl":{"description":"A web link to a picture of this article. Please make sure that no authentication is required to fetch the image!","type":"string"},"tenantArticleId":{"description":"This is a reference to an article number","type":"string"},"title":{"description":"The title of the product","type":"string"},"weight":{"description":"weight value is in gram","minimum":0,"type":"number"}},"required":["tenantArticleId","title"],"title":"ServiceDataItemArticle","type":"object","description":"ServiceDataItemArticle"},"LocaleString":{"additionalProperties":{"type":"string"},"description":"Provides Localized values. The key is the locale, the value is the translation. https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/localization","title":"LocaleString","type":"object"},"ArticleAttributeItem":{"properties":{"valueLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category"},"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations for the key of the attribute. This can be only filled with a descriptive category. Excluding for %%subtitle%%"},"category":{"description":"This category is used by OCFF to customize implemented processes.\nCategorized attributes are used by various processes and tools\nthroughout our platform. For a complete list of possible categories\nand the correct use of those please refer to the documentation.\nDefault value: miscellaneous","enum":["descriptive","miscellaneous","pickingSequence","customs","insurance","shop","dimensions","carrierService","salesPrice","basePrice","tax","discount","surcharge","subtotalBeforeDiscounts","subtotalAfterDiscounts","finalUnitPrice","finalLineItemPrice"],"type":"string"},"context":{"allOf":[{"$ref":"#/components/schemas/ArticleAttributeItemContext"}],"description":"Context for salesPrice category and valuePerUnit key. Can only be set via Listing endpoints."},"key":{"description":"Providing the key %%subtitle%% (see example) here will cause the\nvalue to appear for example in the App directly under the title.\nWith all other attributes also the key will be displayed in the\n clients.","minLength":1,"type":"string"},"priority":{"description":"This value gives the priority in the respective attribute category.\nThe lower the value the higher is the priority, e.g. priority 1 is\nhigher than priority 10. Attributes that have the highest priority\nmight be selected for display in different articles of OCFF. Default\nValue is 1001. For details please contact the product owners.","format":"int64","maximum":1001,"minimum":1,"type":"integer"},"type":{"default":"STRING","description":"The type of the attribute.","enum":["STRING","NUMBER","CURRENCY","BOOLEAN"],"type":"string"},"value":{"minLength":1,"type":"string"}},"required":["key","value"],"title":"ArticleAttributeItem","type":"object","description":"ArticleAttributeItem"},"ArticleAttributeItemContext":{"properties":{"type":{"description":"Indicates the entity type the value refers to.","enum":["FACILITY_GROUP","FACILITY","TAG_REFERENCE"],"type":"string"},"value":{"description":"Holds the reference to the entity the attribute refers to.","minLength":1,"type":"string"}},"required":["type","value"],"title":"ArticleAttributeItemContext","type":"object","description":"ArticleAttributeItemContext"},"ServiceDataExecutedServiceJobs":{"properties":{"appliedQuantity":{"description":"Quantity of the item that has been selected from this service job","minimum":0,"type":"integer"},"itemsReturnable":{"description":"Indicates if the item is returnable based on the used service job definition while adding the items","type":"boolean"},"sequence":{"description":"sequence in which this service job has been executed for this line item. the lower, the earlier it has been executed.","minimum":1,"type":"integer"},"serviceJobRef":{"description":"Id of the Service Job, that has been applied to the ServiceDataAvailableLineItem.","minLength":1,"type":"string"}},"required":["serviceJobRef","sequence","appliedQuantity","itemsReturnable"],"title":"ServiceDataExecutedServiceJobs","type":"object","description":"ServiceDataExecutedServiceJobs"},"RecordableAttributeForCreation":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","nullable":true,"type":"string"}},"required":["keyLocalized","recordingRule"],"title":"RecordableAttributeForCreation","type":"object","description":"RecordableAttributeForCreation"},"RemoveServiceDataAvailableLineItemsActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'REMOVE_SERVICE_DATA_AVAILABLE_LINE_ITEMS'","enum":["REMOVE_SERVICE_DATA_AVAILABLE_LINE_ITEMS"],"type":"string"},"serviceDataAvailableLineItemIds":{"description":"Ids of the service data available line items to be removed","items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"serviceDataVersion":{"description":"Version of the service data","minimum":0,"type":"integer"}},"required":["name","serviceDataAvailableLineItemIds","serviceDataVersion"],"title":"RemoveServiceDataAvailableLineItemsActionParameter","type":"object","description":"RemoveServiceDataAvailableLineItemsActionParameter"},"UpdateServiceDataAvailableLineItemsActionParameter":{"properties":{"name":{"description":"Name of the action to perform, must be 'UPDATE_SERVICE_DATA_AVAILABLE_LINE_ITEMS'","enum":["UPDATE_SERVICE_DATA_AVAILABLE_LINE_ITEMS"],"type":"string"},"serviceDataAvailableLineItemsUpdates":{"description":"availableLineItem Updates","items":{"$ref":"#/components/schemas/ServiceDataAvailableLineItemForUpdate"},"maxItems":50,"minItems":1,"type":"array"},"serviceDataVersion":{"description":"Version of the service data","minimum":0,"type":"integer"}},"required":["name","serviceDataAvailableLineItemsUpdates","serviceDataVersion"],"title":"UpdateServiceDataAvailableLineItemsActionParameter","type":"object","description":"UpdateServiceDataAvailableLineItemsActionParameter"},"ServiceDataAvailableLineItemForUpdate":{"properties":{"availableQuantity":{"description":"Available quantity of the items","minimum":0,"type":"integer"},"executedServiceJobData":{"description":"Updated history of service jobs that have processed this line item","items":{"$ref":"#/components/schemas/ServiceDataExecutedServiceJobs"},"maxItems":50,"type":"array"},"id":{"description":"ID of the available line item to update","minLength":1,"type":"string"},"quantity":{"description":"Quantity of the items","minimum":0,"type":"integer"}},"required":["id"],"title":"ServiceDataAvailableLineItemForUpdate","type":"object","description":"ServiceDataAvailableLineItemForUpdate"},"ServiceData":{"properties":{"availableLineItems":{"description":"Information about the items that are available for the service job.","items":{"$ref":"#/components/schemas/ServiceDataAvailableLineItem"},"maxItems":200,"type":"array"},"created":{"description":"The date this entity was created at the platform. This value is generated by the service.","format":"date-time","type":"string"},"id":{"description":"ID of the Service Data","minLength":1,"type":"string"},"lastModified":{"description":"The date this entity was modified last. This value is generated by the service.","format":"date-time","type":"string"},"serviceJobRefs":{"description":"IDs of all serviceJobs connected to this service data","items":{"type":"string"},"maxItems":50,"minItems":1,"type":"array"},"version":{"description":"The version of the document to be used in optimistic locking mechanisms.","format":"int64","type":"integer"}},"required":["serviceJobRefs","availableLineItems","created","lastModified","version","id"],"title":"ServiceData","type":"object","description":"ServiceData"},"ServiceDataAvailableLineItem":{"properties":{"article":{"allOf":[{"$ref":"#/components/schemas/ServiceDataItemArticle"}],"description":"Article information for this available line item"},"availableQuantity":{"description":"Quantity of the item that is available","minimum":0,"type":"integer"},"customAttributes":{"description":"Attributes that can be added to the lineItem. These attributes cannot be used within fulfillment processes, but it could be useful to have the information carried here.","type":"object"},"executedServiceJobData":{"description":"History of service jobs that have processed this available line item","items":{"$ref":"#/components/schemas/ServiceDataExecutedServiceJobs"},"maxItems":50,"type":"array"},"globalLineItemId":{"description":"This id is used to identify if this line item is related to the line item of other operational entities.","type":"string"},"id":{"description":"ID of the available line item","minLength":1,"type":"string"},"measurementUnitKey":{"description":"Measurement unit key of the item, for example \"pcs\" or \"kg\"","minLength":1,"type":"string"},"originId":{"description":"The id of the line item this line item was originated from, before any split has happened. This can be used to restore the 'pre-split' status.","minLength":1,"nullable":true,"type":"string"},"quantity":{"description":"The quantity of the lineItem","type":"number"},"recordableAttributes":{"description":"Customizable information about the lineItem that can be set during the process.","items":{"$ref":"#/components/schemas/RecordableAttribute"},"type":"array"},"scannableCodes":{"description":"Codes that can be used for scanning this lineItem","items":{"type":"string"},"type":"array"}},"required":["id","article","quantity","availableQuantity","executedServiceJobData"],"title":"ServiceDataAvailableLineItem","type":"object","description":"ServiceDataAvailableLineItem"},"RecordableAttribute":{"additionalProperties":false,"properties":{"keyLocalized":{"allOf":[{"$ref":"#/components/schemas/LocaleString"}],"description":"The translations of the key"},"group":{"description":"The group of the attribute","minLength":1,"nullable":true,"type":"string"},"id":{"description":"id of the recordable attribute","type":"string"},"key":{"description":"The translated key of the attribute. This field gets filled automatically on request","type":"string"},"originId":{"description":"The id of the original lineItem the attribute was split from.","nullable":true,"type":"string"},"recordingRule":{"description":"Indicates whether the value has to be recorded or not","enum":["OPTIONAL","MANDATORY"],"type":"string"},"value":{"description":"The value of the attribute","minLength":1,"nullable":true,"type":"string"}},"required":["id","keyLocalized","recordingRule"],"title":"RecordableAttribute","type":"object","description":"RecordableAttribute"},"ApiError":{"items":{"$ref":"#/components/schemas/ErrorInner"},"type":"array","xml":{"name":"ApiError"},"title":"ApiError","description":"ApiError"},"ErrorInner":{"properties":{"description":{"type":"string"},"requestVersion":{"description":"The version provided within an invalid request.","format":"int64","type":"integer"},"summary":{"type":"string"},"version":{"format":"int64","type":"integer"}},"required":["summary"],"type":"object","title":"ErrorInner","description":"ErrorInner"}}},"paths":{"/api/servicejobs/{serviceJobId}/servicedata/actions":{"post":{"deprecated":false,"description":"This part of the API is in Beta status. For details please check the <a href=\"https://docs.fulfillmenttools.com/documentation/developer-docs/api/core-concepts/api-release-life-cycle#beta\" target=\"_blank\">api-release-life-cycle documentation</a>.<br /><br />Apply an action to the service data of the referenced service job.","operationId":"updateServiceData","parameters":[{"description":"ID of service job referenced by the service data you want to update","in":"path","name":"serviceJobId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ServiceItemSelectQuantityActionParameter"},{"$ref":"#/components/schemas/ServiceItemUnselectQuantityActionParameter"},{"$ref":"#/components/schemas/AddServiceDataAvailableLineItemsActionParameter"},{"$ref":"#/components/schemas/RemoveServiceDataAvailableLineItemsActionParameter"},{"$ref":"#/components/schemas/UpdateServiceDataAvailableLineItemsActionParameter"}]}}},"description":"Desired change to service data","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceData"}}},"description":"The service data was successfully updated."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Invalid input. See response for details."},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user is not allowed to operate against this API instance"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}},"description":"Your user, although recognized, is not authorized to use this endpoint"}},"summary":"Call service data action","tags":["Services (Operations)"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.fulfillmenttools.com/documentation/apis/api-reference/services-operations.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.