Services (Operations)
number of entities to show
25Example: 25all entities after given Id
6db6a29b-143d-4ffd-ab8b-45cd299cdb00facilities to filter to
["6027cece-93b8-4628-9314-a3f455af9e46"]sort order
TARGET_TIME_ASCPossible values: Start target date range for linked service jobs
2020-02-03T08:45:50.525ZEnd target date range for linked service jobs
2020-02-03T08:45:50.525Ztype of channel you want to filter for
COLLECTPossible values: Search term you want to get the corresponding linked service jobs. Search will be performed on multiple fields, like tenantOrderId, consumerName, tenantArticleId and more
John DoeReference to the username you want to get the corresponding linkedServiceJobs for
john.doeLinkedServiceJobs can be found in response body.
LinkedServiceJobsResult
Total number of found entities for this query
42Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
ID of LinkedServiceJobs you want to get
LinkedServiceJobs can be found in response body.
LinkedServiceJobs
The date this entity was created by fulfillmenttools. This value is generated by the service.
2020-02-03T08:45:51.525ZId linked Facility from the includes service jobs
cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05Full identifier of the service job. Using the full name of the customer when created from an order.
240429_lorem-42Unique ID of this linked service jobs group
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1searchable field of all included service job link ids
["cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"]searchable field of all included service job ids
["cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"]The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZReference to the operative process this linked service jobs group belongs to
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1Current status of this linked service jobs group
OPENPossible values: Target time by which all linked service jobs are expected to be completed
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
ID of LinkedServiceJobs you want to alter
ServiceJobLinkForAdding
ID of the service job to add to this linked service jobs group
0ed803c2-fa20-48d9-9c1b-0d243937a9adThe ServiceJobLink was successfully added to the LinkedServiceJobs.
LinkedServiceJobs
The date this entity was created by fulfillmenttools. This value is generated by the service.
2020-02-03T08:45:51.525ZId linked Facility from the includes service jobs
cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05Full identifier of the service job. Using the full name of the customer when created from an order.
240429_lorem-42Unique ID of this linked service jobs group
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1searchable field of all included service job link ids
["cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"]searchable field of all included service job ids
["cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"]The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZReference to the operative process this linked service jobs group belongs to
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1Current status of this linked service jobs group
OPENPossible values: Target time by which all linked service jobs are expected to be completed
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42Invalid input. See response for details.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
ID of LinkedServiceJobs you want to alter
ID of ServiceJobLink you want to add the new ServiceJobLink underneath
ServiceJobLinkForAdding
ID of the service job to add to this linked service jobs group
0ed803c2-fa20-48d9-9c1b-0d243937a9adThe ServiceJobLink was successfully added nested inside the LinkedServiceJobs.
LinkedServiceJobs
The date this entity was created by fulfillmenttools. This value is generated by the service.
2020-02-03T08:45:51.525ZId linked Facility from the includes service jobs
cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05Full identifier of the service job. Using the full name of the customer when created from an order.
240429_lorem-42Unique ID of this linked service jobs group
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1searchable field of all included service job link ids
["cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"]searchable field of all included service job ids
["cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"]The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZReference to the operative process this linked service jobs group belongs to
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1ProcessRef of the added ServiceJobs. All Service Jobs need to be part of the same process
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1Current status of this linked service jobs group
OPENPossible values: Target time by which all linked service jobs are expected to be completed
2020-02-03T09:45:51.525ZThe version of the document to be used in optimistic locking mechanisms.
42Invalid input. See response for details.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
LinkedServiceJobsSearchPayload
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.
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).
Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
10The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.
Your search result
LinkedServiceJobsPaginatedResult
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
number of entities to show
25Example: 25all entities after given Id
6db6a29b-143d-4ffd-ab8b-45cd299cdb00sorting for the results
CREATED_DESCPossible values: Reference of the facility you want to filter for
["ba095e30-879f-11ee-b9d1-0242ac120002"]Reference of the service job you want to filter for
41d43211-g5a1-gg22-a716-ba095e30ds1dService containers can be found in response body.
ServiceContainers
Total number of found entities for this query
42Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
ServiceContainerForCreation
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.
URL to an icon representing this container type.
https://example.com/icon.pngReference to the operative container type this container is based on.
41d43211-g5a1-gg22-a716-ba095e30ds1dCodes that can be used for scanning this container.
["AB-123456"]Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.
42Ids of the ServiceJobs this container belongs to.
["cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"]Reference to related stack
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1Id of the storage location this container is located at.
41d43211-g5a1-gg22-a716-ba095e30ds1dWeight limit of the container in grams.
5000The service container was successfully created.
ServiceContainer
The date this entity was created by fulfillmenttools. This value is generated by the service.
2020-02-03T08:45:51.525ZAttributes 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.
Translated description, filled on request based on descriptionLocalized.
A medium-sized red boxId of the facility this container is used in.
ba095e30-879f-11ee-b9d1-0242ac120002URL to an icon representing this container type.
https://example.com/icon.pngThe id of this entity. It is generated during creation automatically and suits as the primary identifier of the described entity.
41d43211-g5a1-gg22-a716-ba095e30ds1dThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZTranslated name, filled on request based on nameLocalized.
Red BoxReference to the operative container type this container is based on.
41d43211-g5a1-gg22-a716-ba095e30ds1dCodes that can be used for scanning this container.
["AB-123456"]Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.
42Ids of the ServiceJobs this container belongs to.
["cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"]Reference to related stack
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1The status of the service container. It can be AVAILABLE or OBSOLETE. The status cannot be set from outside. When a service container is created, it is automatically set to AVAILABLE. When a service container is deleted, it is automatically set to OBSOLETE.
AVAILABLEExample: AVAILABLEPossible values: Id of the storage location this container is located at.
41d43211-g5a1-gg22-a716-ba095e30ds1dType of this service container
DEFAULTPossible values: The version of the document to be used in optimistic locking mechanisms.
42Weight limit of the container in grams.
5000Invalid input. See response for details.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
ID of the service container to retrieve
Service container for the given id.
ServiceContainer
The date this entity was created by fulfillmenttools. This value is generated by the service.
2020-02-03T08:45:51.525ZAttributes 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.
Translated description, filled on request based on descriptionLocalized.
A medium-sized red boxId of the facility this container is used in.
ba095e30-879f-11ee-b9d1-0242ac120002URL to an icon representing this container type.
https://example.com/icon.pngThe id of this entity. It is generated during creation automatically and suits as the primary identifier of the described entity.
41d43211-g5a1-gg22-a716-ba095e30ds1dThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZTranslated name, filled on request based on nameLocalized.
Red BoxReference to the operative container type this container is based on.
41d43211-g5a1-gg22-a716-ba095e30ds1dCodes that can be used for scanning this container.
["AB-123456"]Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.
42Ids of the ServiceJobs this container belongs to.
["cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"]Reference to related stack
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1The status of the service container. It can be AVAILABLE or OBSOLETE. The status cannot be set from outside. When a service container is created, it is automatically set to AVAILABLE. When a service container is deleted, it is automatically set to OBSOLETE.
AVAILABLEExample: AVAILABLEPossible values: Id of the storage location this container is located at.
41d43211-g5a1-gg22-a716-ba095e30ds1dType of this service container
DEFAULTPossible values: The version of the document to be used in optimistic locking mechanisms.
42Weight limit of the container in grams.
5000Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
ID of the service container to delete
The service container has successfully been set to OBSOLETE.
No content
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
No content
number of entities to show
25Example: 25all entities after given Id
6db6a29b-143d-4ffd-ab8b-45cd299cdb00Reference of the facility you want to filter for
6027cece-93b8-4628-9314-a3f455af9e46Type of channel you want to filter for
COLLECTPossible values: Start target date range for service jobs
2020-02-03T08:45:50.525ZEnd target date range for service jobs
2020-02-03T08:45:50.525ZOrder in which the result should be returned
TARGET_TIME_ASCPossible values: Search term you want to get the corresponding service jobs. Search will be performed on multiple fields, like tenantOrderId, consumerName, tenantArticleId and more
John DoeReference the assigned user on this entity - id or username
USER_IDService Jobs can be found in response body.
ServiceJobs
Total number of found entities for this query
42Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
ServiceJobForCreation
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.
ID of the Custom Service, the Service Job should reference. Either this and/or the tenantCustomServiceId must passed.
41d43211-g5a1-gg22-a716-ba095e30ds1dID of the Facility, the Service Job is executed in.
ba095e30-879f-11ee-b9d1-0242ac120002Reference to the operative process this service job is part of
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1ID of the Process, the Service Job belongs to.
550e8400-e29b-41d4-a716-446655440000ID of the Service Job Link, the Service Job should reference.
41d43211-g5a1-gg22-a716-ba095e30ds1dShort human-readable identifier for this service job
KD-12-1At which time the service job is expected to be finished.
2020-02-03T09:45:51.525ZTenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.
41d43211-g5a1-gg22-a716-ba095e30ds1dID of the tenant order, the linked service jobs are part of
ocff-order-100The service job was successfully created.
ServiceJob
Indicates if gdpr related data was anonymized
falseThe date this entity was created by fulfillmenttools. This value is generated by the service.
2020-02-03T08:45:51.525ZAttributes 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.
Id of the customService this ServiceJob was created from.
41d43211-g5a1-gg22-a716-ba095e30ds1dTranslated description of this service job derived from descriptionLocalized
Wrapping 3 gifts for order ocff-order-100Time in minutes this service job is expected to take to be executed
60ID of the Facility, the Service Job is executed in.
ba095e30-879f-11ee-b9d1-0242ac120002Unique ID of this service job
41d43211-g5a1-gg22-a716-ba095e30ds1dList of linked images taken from the connected custom service
["https://my-image-host.com/images/custom-service-1.jpg"]Indicates whether items are required for executing this service job
OPTIONALPossible values: Indicates if the items worked on in this service job are returnable after execution
falseThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZID of the Linked Service Job, the Service Job should reference.
41d43211-g5a1-gg22-a716-ba095e30ds1dTranslated name of this service job derived from nameLocalized
Gift Wrapping JobReference to the operative process this service job is part of
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1ID of the process this service job belongs to
550e8400-e29b-41d4-a716-446655440000ID of the Service Job Link, the Service Job should reference.
41d43211-g5a1-gg22-a716-ba095e30ds1dShort human-readable identifier for this service job
KD-12-1Current status of this service job
OPENPossible values: Additional sub-status information about this service job
WAITING_FOR_INPUTPossible values: At which time the service job is expected to be finished.
2020-02-03T09:45:51.525ZTenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.
41d43211-g5a1-gg22-a716-ba095e30ds1dID of the tenant order, the linked service jobs are part of
ocff-order-100The version of the document to be used in optimistic locking mechanisms.
42Invalid input. See response for details.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
ID of service job you want to get
Service Job can be found in response body.
ServiceJob
Indicates if gdpr related data was anonymized
falseThe date this entity was created by fulfillmenttools. This value is generated by the service.
2020-02-03T08:45:51.525ZAttributes 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.
Id of the customService this ServiceJob was created from.
41d43211-g5a1-gg22-a716-ba095e30ds1dTranslated description of this service job derived from descriptionLocalized
Wrapping 3 gifts for order ocff-order-100Time in minutes this service job is expected to take to be executed
60ID of the Facility, the Service Job is executed in.
ba095e30-879f-11ee-b9d1-0242ac120002Unique ID of this service job
41d43211-g5a1-gg22-a716-ba095e30ds1dList of linked images taken from the connected custom service
["https://my-image-host.com/images/custom-service-1.jpg"]Indicates whether items are required for executing this service job
OPTIONALPossible values: Indicates if the items worked on in this service job are returnable after execution
falseThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZID of the Linked Service Job, the Service Job should reference.
41d43211-g5a1-gg22-a716-ba095e30ds1dTranslated name of this service job derived from nameLocalized
Gift Wrapping JobReference to the operative process this service job is part of
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1ID of the process this service job belongs to
550e8400-e29b-41d4-a716-446655440000ID of the Service Job Link, the Service Job should reference.
41d43211-g5a1-gg22-a716-ba095e30ds1dShort human-readable identifier for this service job
KD-12-1Current status of this service job
OPENPossible values: Additional sub-status information about this service job
WAITING_FOR_INPUTPossible values: At which time the service job is expected to be finished.
2020-02-03T09:45:51.525ZTenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.
41d43211-g5a1-gg22-a716-ba095e30ds1dID of the tenant order, the linked service jobs are part of
ocff-order-100The version of the document to be used in optimistic locking mechanisms.
42Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
ID of service job you want to update
The service job was successfully updated.
ServiceJob
Indicates if gdpr related data was anonymized
falseThe date this entity was created by fulfillmenttools. This value is generated by the service.
2020-02-03T08:45:51.525ZAttributes 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.
Id of the customService this ServiceJob was created from.
41d43211-g5a1-gg22-a716-ba095e30ds1dTranslated description of this service job derived from descriptionLocalized
Wrapping 3 gifts for order ocff-order-100Time in minutes this service job is expected to take to be executed
60ID of the Facility, the Service Job is executed in.
ba095e30-879f-11ee-b9d1-0242ac120002Unique ID of this service job
41d43211-g5a1-gg22-a716-ba095e30ds1dList of linked images taken from the connected custom service
["https://my-image-host.com/images/custom-service-1.jpg"]Indicates whether items are required for executing this service job
OPTIONALPossible values: Indicates if the items worked on in this service job are returnable after execution
falseThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZID of the Linked Service Job, the Service Job should reference.
41d43211-g5a1-gg22-a716-ba095e30ds1dTranslated name of this service job derived from nameLocalized
Gift Wrapping JobReference to the operative process this service job is part of
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1ID of the process this service job belongs to
550e8400-e29b-41d4-a716-446655440000ID of the Service Job Link, the Service Job should reference.
41d43211-g5a1-gg22-a716-ba095e30ds1dShort human-readable identifier for this service job
KD-12-1Current status of this service job
OPENPossible values: Additional sub-status information about this service job
WAITING_FOR_INPUTPossible values: At which time the service job is expected to be finished.
2020-02-03T09:45:51.525ZTenant ID of the Custom Service, the Service Job should reference. Either this and/or the customServiceRef must passed.
41d43211-g5a1-gg22-a716-ba095e30ds1dID of the tenant order, the linked service jobs are part of
ocff-order-100The version of the document to be used in optimistic locking mechanisms.
42Invalid input. See response for details.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
ID of the service job to retrieve containers for
Service containers for the given service job.
ServiceContainer
The date this entity was created by fulfillmenttools. This value is generated by the service.
2020-02-03T08:45:51.525ZAttributes 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.
Translated description, filled on request based on descriptionLocalized.
A medium-sized red boxId of the facility this container is used in.
ba095e30-879f-11ee-b9d1-0242ac120002URL to an icon representing this container type.
https://example.com/icon.pngThe id of this entity. It is generated during creation automatically and suits as the primary identifier of the described entity.
41d43211-g5a1-gg22-a716-ba095e30ds1dThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZTranslated name, filled on request based on nameLocalized.
Red BoxReference to the operative container type this container is based on.
41d43211-g5a1-gg22-a716-ba095e30ds1dCodes that can be used for scanning this container.
["AB-123456"]Incremental number to distinguish containers of the same type. Virtual container's sequenceNumber is always 0, non virtual containers are always greater than 0.
42Ids of the ServiceJobs this container belongs to.
["cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"]Reference to related stack
9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1The status of the service container. It can be AVAILABLE or OBSOLETE. The status cannot be set from outside. When a service container is created, it is automatically set to AVAILABLE. When a service container is deleted, it is automatically set to OBSOLETE.
AVAILABLEExample: AVAILABLEPossible values: Id of the storage location this container is located at.
41d43211-g5a1-gg22-a716-ba095e30ds1dType of this service container
DEFAULTPossible values: The version of the document to be used in optimistic locking mechanisms.
42Weight limit of the container in grams.
5000Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
ID of service job referenced by the service data you want to get
Service Data can be found in response body.
ServiceData
The date this entity was created by fulfillmenttools. This value is generated by the service.
2020-02-03T08:45:51.525ZID of the Service Data
41d43211-g5a1-gg22-a716-ba095e30ds1dThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZIDs of all serviceJobs connected to this service data
["cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"]The version of the document to be used in optimistic locking mechanisms.
42Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
The requested entity was not found
ID of service job referenced by the service data you want to update
The service data was successfully updated.
ServiceData
The date this entity was created by fulfillmenttools. This value is generated by the service.
2020-02-03T08:45:51.525ZID of the Service Data
41d43211-g5a1-gg22-a716-ba095e30ds1dThe date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525ZIDs of all serviceJobs connected to this service data
["cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"]The version of the document to be used in optimistic locking mechanisms.
42Invalid input. See response for details.
Your user is not allowed to operate against this API instance
Your user, although recognized, is not authorized to use this endpoint
Last updated