Picking endpoints
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
PickJobForCreation
customAttributesobjectOptional
Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
facilityRefstringRequiredExample:
The id of the facility reference. The given ID has to be present in the system.
Esb20gpHBL94X5NdMp3CoperativeProcessRefstringOptional
orderDatestring · date-timeRequiredExample:
The date this order was created at the supplying system.
2020-02-03T08:45:50.525ZorderRefstringOptionalExample:
The id of the order reference. The given ID has to be present in the system.
LGMl2DuvPnfPoSHhYFOmprocessIdstringOptional
Id of the global process related to this entity. For example used for starting the GDPR process and others.
routingPlanRefstringOptional
Reference to the routingplan which created this pickjob
shortIdstringOptionalExample:
A short identifier that helps assigning a pick job to a customer.
AS12statusstring · enumOptionalPossible values:
The status of a pickjob.
tenantOrderIdstringOptionalExample:
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546workflowInformationone ofOptional
or
Responses
201
The pick job was successfully created. The Location header contains the URL of the pickjob.
application/json
VersionedResource
customAttributesobjectOptional
Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
facilityRefstringRequiredExample:
The id of the facility reference. The given ID has to be present in the system.
Esb20gpHBL94X5NdMp3CoperativeProcessRefstringOptional
orderDatestring · date-timeRequiredExample:
The date this order was created at the supplying system.
2020-02-03T08:45:50.525ZorderRefstringOptionalExample:
The id of the order reference. The given ID has to be present in the system.
LGMl2DuvPnfPoSHhYFOmprocessIdstringOptional
Id of the global process related to this entity. For example used for starting the GDPR process and others.
routingPlanRefstringOptional
Reference to the routingplan which created this pickjob
shortIdstringRequiredExample:
A short identifier that helps assigning a pickJob to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
The status of a pickjob.
tenantOrderIdstringOptionalExample:
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546workflowInformationone ofRequired
or
createdstring · date-timeOptionalExample:
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZlastModifiedstring · date-timeOptionalExample:
The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525Zversioninteger · int64RequiredExample:
The version of the document to be used in optimistic locking mechanisms.
42anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsedocumentsRefstringRequired
Reference to the documents collection from this entity
idstringRequiredExample:
The id of this pickjob. It is generated during creation automatically and suits as the primary identifier of the described entity.
Esb20gpHBL94X5NdMp3CpickRunRefstringOptional
Pick run id to which the pick job belongs
resetBlockedbooleanOptionalDefault:
Indicates if pickJob can still be resetted or restarted
falsestatusReasonstringOptionalDeprecated
deprecated: Use subStatus instead. Maintained for backward compatibility.
subStatusstring · enumOptionalPossible values:
The reason for the current status.
400
Invalid input. See response for details
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
post/api/pickjobs
POST /api/pickjobs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 4086
{
"assignedUsers": [
{
"username": "text"
}
],
"customAttributes": {},
"deliveryinformation": {
"channel": "COLLECT",
"details": {
"collect": {
"identifier": "text",
"paid": false
},
"shipping": {
"carrierKey": "text",
"carrierProduct": "EXPRESS",
"carrierProductCategory": "STANDARD",
"carrierServices": [
"SIGNATURE"
],
"identifier": "text",
"invoiceAddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"postalAddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"recipientaddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"serviceLevel": "DELIVERY"
}
},
"targetTime": "2020-02-03T09:45:51.525Z",
"targetTimeBaseDate": "2020-02-03T08:45:50.525Z"
},
"expectedPickLineItems": [],
"facilityRef": "Esb20gpHBL94X5NdMp3C",
"operativeProcessRef": "text",
"orderDate": "2020-02-03T08:45:50.525Z",
"orderRef": "LGMl2DuvPnfPoSHhYFOm",
"paymentInformation": {
"currency": "EUR"
},
"pickingTimes": {
"startLatestAt": "2024-02-03T09:45:51.525Z"
},
"pickLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"globalLineItemId": "text",
"measurementUnitKey": "pcs",
"quantity": 1,
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"recordingRule": "MANDATORY",
"validations": [
{
"allowedValues": [
{
"type": "STRING"
}
],
"type": "EXACT_MATCH"
}
],
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "g",
"secondaryQuantity": 42,
"substituteForOrderedItem": {
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"globalLineItemId": "text"
}
}
],
"preferredPickingMethods": [
"SINGLE_ORDER"
],
"processId": "text",
"routingPlanRef": "text",
"shortId": "AS12",
"status": "ABORTED",
"stickers": [],
"tenantOrderId": "R456728546",
"transfers": [
{
"id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
"type": "RECEIVER"
}
],
"workflowInformation": {
"instanceRef": "64c13ab08edf48a008793cac",
"isAvailable": true,
"nodeRef": "text"
},
"tags": []
}{
"assignedUsers": [
{
"userId": "text",
"username": "text"
}
],
"customAttributes": {},
"deliveryinformation": {
"channel": "COLLECT",
"details": {
"collect": {
"identifier": "text",
"paid": false
},
"shipping": {
"carrierKey": "text",
"carrierProduct": "EXPRESS",
"carrierProductCategory": "STANDARD",
"carrierServices": [
"SIGNATURE"
],
"identifier": "text",
"invoiceAddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"postalAddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"recipientaddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"serviceLevel": "DELIVERY"
}
},
"targetTime": "2020-02-03T09:45:51.525Z",
"targetTimeBaseDate": "2020-02-03T08:45:50.525Z"
},
"expectedPickLineItems": [
{
"allowedSubstitutes": [
{
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"priority": 1,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"tenantArticleId": "text",
"title": "text"
}
],
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"partialStockLocations": [
{
"available": 21,
"location": {
"locationRef": "text",
"scannableCodes": [
"text"
]
},
"quantity": 21,
"ratingScore": 1,
"sequenceScore": 1,
"stockProperties": {
"expiry": "text"
},
"stockRef": "text",
"tenantPartialStockId": "text"
}
],
"quantity": 21,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "liter",
"secondaryQuantity": 21,
"stickers": [],
"transferId": "text",
"tags": []
},
{
"id": "climk4dcQFiPdA5ULuhS"
}
],
"facilityRef": "Esb20gpHBL94X5NdMp3C",
"operativeProcessRef": "text",
"orderDate": "2020-02-03T08:45:50.525Z",
"orderRef": "LGMl2DuvPnfPoSHhYFOm",
"paymentInformation": {
"currency": "EUR"
},
"pickingTimes": {
"startLatestAt": "2024-02-03T09:45:51.525Z"
},
"pickLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"globalLineItemId": "a81f818e-2405-4570-8cde-b0c80fd3de31",
"id": "climk4dcQFiPdA5ULuhS",
"measurementUnitKey": "liter",
"quantity": 21,
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "liter",
"secondaryQuantity": 21,
"allowedSubstitutes": [
{
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"priority": 1,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"tenantArticleId": "text",
"title": "text"
}
],
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
"partialStockLocations": [
{
"available": 21,
"location": {
"locationRef": "text",
"scannableCodes": [
"text"
]
},
"quantity": 21,
"ratingScore": 1,
"sequenceScore": 1,
"stockProperties": {
"expiry": "text"
},
"stockRef": "text",
"tenantPartialStockId": "text"
}
],
"picked": 20,
"pickedAt": "2024-02-03T08:45:51.525Z",
"pickJobLineItemRef": "12345",
"scannedCodes": [
{
"code": 1245678,
"quantity": 7
}
],
"scanningRules": {
"scanningMode": "MUST_SCAN_FIRST",
"scanningType": [
{
"priority": 1,
"scanningRuleType": "ARTICLE"
}
]
},
"secondaryPicked": 20,
"shortPickReason": {
"reasonLocalized": "{ en_US: 'SomeName' }",
"reason": "text"
},
"status": "OPEN",
"stickers": [],
"stockEmptied": true,
"substituteLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1,
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
]
},
"globalLineItemId": "text",
"id": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"partialStockLocations": [
{
"location": {
"locationRef": "text",
"scannableCodes": [
"text"
]
},
"picked": 21,
"quantity": 21,
"ratingScore": 1,
"sequenceScore": 1,
"stockProperties": {
"expiry": "text"
},
"stockRef": "text",
"tenantPartialStockId": "text",
"zoneName": "text"
}
],
"picked": 20,
"pickedAt": "2024-02-03T08:45:51.525Z",
"priority": 1,
"quantity": 21,
"refused": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "text",
"quantity": 1,
"reason": "text"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"secondaryPicked": 20,
"secondaryQuantity": 200
}
],
"tags": []
}
],
"preferredPickingMethods": [
"SINGLE_ORDER"
],
"processId": "text",
"routingPlanRef": "text",
"shortId": "AS12",
"status": "ABORTED",
"stickers": [],
"tenantOrderId": "R456728546",
"transfers": [
{
"id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
"type": "RECEIVER"
}
],
"workflowInformation": {
"instanceRef": "64c13ab08edf48a008793cac",
"isAvailable": true,
"nodeRef": "text"
},
"tags": [],
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42,
"anonymized": false,
"documentHandling": {
"sendLabel": {
"enabled": false
}
},
"documentsRef": "text",
"editor": {
"userId": "text",
"username": "text"
},
"id": "Esb20gpHBL94X5NdMp3C",
"pickingZones": [
{
"zoneRef": "text"
}
],
"pickRunRef": "text",
"resetBlocked": false,
"subStatus": "SHORT_PICKED",
"usersModificationHistory": [
{
"modificationDate": "2026-01-01T00:00:00.000Z",
"userId": "text",
"username": "text"
}
]
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
searchTermstringOptional
Search term you want to get the corresponding pickjobs. Search will be performed on multiple fields, like tenantOrderId, consumerName, tenantArticleId and more
carrierKeysstring[]Optional
Reference to the carrier you want to get the corresponding pickjobs
startOrderDatestringOptional
Reference to the orderDate you want to get the corresponding pickjobs
endOrderDatestringOptional
Reference to the orderDate you want to get the corresponding pickjobs
orderRefstringOptional
Reference to the order you want to get the corresponding pickjobs
facilityRefstringOptional
Reference to the facility you want to get the corresponding pickjobs
assignedUserstringOptional
Reference the assigned user on this entity - id or username
statusstring[]Optional
Reference to the status you want to get the corresponding pickjobs
zoneRefsstring[]Optional
Reference to the zones you want to get the corresponding pickjobs
tenantOrderIdstringOptional
Reference to the tenantOrderId you want to get the corresponding pickjobs
channelstring · enumOptionalPossible values:
The channel of the pickJob you want to filter by
consumerNamestringOptional
Reference to the consumer name you want to get the corresponding pickjobs
shortIdstringOptional
Reference to the shortId you want to get the corresponding pickjobs
articleTitlestringOptional
Reference to the articleTitle you want to get the corresponding pickjobs
anonymizedbooleanOptional
Reference to the anonymized you want to get the corresponding pickjobs
startAfterIdstringOptional
all entities after given Id
sizeintegerOptionalDefault:
number of entities to show
25orderBystringOptional
query pickjobs orderBy
startTargetTimestring · date-timeOptionalExample:
Start date range for pick jobs
2020-02-03T08:45:50.525ZendTargetTimestring · date-timeOptionalExample:
End date range for pick jobs
2020-02-03T08:45:50.525ZpickJobRefsstring[]Optional
Reference to pickjobs
modifiedByUsernamestringOptional
Reference to the user ID you want to get the corresponding pickjobs
Responses
200
PickJobs were found. The results are in the body.
application/json
StrippedPickJobs
totalintegerOptionalExample:
Total number of found entities for this query
42401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
get/api/pickjobs
GET /api/pickjobs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"pickjobs": [
{
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42,
"carrierKey": "DPD",
"facilityRef": "Esb20gpHBL94X5NdMp3C",
"id": "text",
"orderRef": "LGMl2DuvPnfPoSHhYFOm",
"searchPaths": [
"text"
],
"status": "ABORTED",
"targetTime": "2020-02-03T09:45:51.525Z"
}
],
"total": 42
}Search for PickJob
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
PickJobSearchPayload
afterstringOptional
The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.
beforestringOptional
The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).
lastnumber · min: 1 · max: 250Optional
Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
sizenumber · min: 1 · max: 250OptionalExample:
Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.
10startAfterIdstringOptionalDeprecated
The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.
Responses
200
Your search result
application/json
PickJobPaginatedResult
totalnumberOptional
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
post/api/pickjobs/search
POST /api/pickjobs/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5908
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"consumerName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"created": {
"after": "text",
"before": "text",
"eq": "2026-01-01T00:00:00.000Z",
"gt": "2026-01-01T00:00:00.000Z",
"gte": "2026-01-01T00:00:00.000Z",
"lt": "2026-01-01T00:00:00.000Z",
"lte": "2026-01-01T00:00:00.000Z",
"notEq": "2026-01-01T00:00:00.000Z"
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"lastModified": {
"after": "text",
"before": "text",
"eq": "2026-01-01T00:00:00.000Z",
"gt": "2026-01-01T00:00:00.000Z",
"gte": "2026-01-01T00:00:00.000Z",
"lt": "2026-01-01T00:00:00.000Z",
"lte": "2026-01-01T00:00:00.000Z",
"notEq": "2026-01-01T00:00:00.000Z"
},
"or": "[Circular Reference]",
"orderRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"preferredPickingMethods": {
"contains": {
"eq": "SINGLE_ORDER",
"in": [
"SINGLE_ORDER"
],
"notEq": "SINGLE_ORDER"
}
},
"status": {
"eq": "ABORTED",
"in": [
"ABORTED"
],
"notEq": "ABORTED"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantArticleIds": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantOrderId": "MY_ORDER_ID",
"transfers": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"exists": true
}
}
],
"consumerName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"created": {
"after": "text",
"before": "text",
"eq": "2026-01-01T00:00:00.000Z",
"gt": "2026-01-01T00:00:00.000Z",
"gte": "2026-01-01T00:00:00.000Z",
"lt": "2026-01-01T00:00:00.000Z",
"lte": "2026-01-01T00:00:00.000Z",
"notEq": "2026-01-01T00:00:00.000Z"
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"lastModified": {
"after": "text",
"before": "text",
"eq": "2026-01-01T00:00:00.000Z",
"gt": "2026-01-01T00:00:00.000Z",
"gte": "2026-01-01T00:00:00.000Z",
"lt": "2026-01-01T00:00:00.000Z",
"lte": "2026-01-01T00:00:00.000Z",
"notEq": "2026-01-01T00:00:00.000Z"
},
"or": [
{
"and": "[Circular Reference]",
"consumerName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"created": {
"after": "text",
"before": "text",
"eq": "2026-01-01T00:00:00.000Z",
"gt": "2026-01-01T00:00:00.000Z",
"gte": "2026-01-01T00:00:00.000Z",
"lt": "2026-01-01T00:00:00.000Z",
"lte": "2026-01-01T00:00:00.000Z",
"notEq": "2026-01-01T00:00:00.000Z"
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"lastModified": {
"after": "text",
"before": "text",
"eq": "2026-01-01T00:00:00.000Z",
"gt": "2026-01-01T00:00:00.000Z",
"gte": "2026-01-01T00:00:00.000Z",
"lt": "2026-01-01T00:00:00.000Z",
"lte": "2026-01-01T00:00:00.000Z",
"notEq": "2026-01-01T00:00:00.000Z"
},
"or": "[Circular Reference]",
"orderRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"preferredPickingMethods": {
"contains": {
"eq": "SINGLE_ORDER",
"in": [
"SINGLE_ORDER"
],
"notEq": "SINGLE_ORDER"
}
},
"status": {
"eq": "ABORTED",
"in": [
"ABORTED"
],
"notEq": "ABORTED"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantArticleIds": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantOrderId": "MY_ORDER_ID",
"transfers": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"exists": true
}
}
],
"orderRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"preferredPickingMethods": {
"contains": {
"eq": "SINGLE_ORDER",
"in": [
"SINGLE_ORDER"
],
"notEq": "SINGLE_ORDER"
}
},
"status": {
"eq": "ABORTED",
"in": [
"ABORTED"
],
"notEq": "ABORTED"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantArticleIds": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantOrderId": "MY_ORDER_ID",
"transfers": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"exists": true
}
}
],
"consumerName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"created": {
"after": "text",
"before": "text",
"eq": "2026-01-01T00:00:00.000Z",
"gt": "2026-01-01T00:00:00.000Z",
"gte": "2026-01-01T00:00:00.000Z",
"lt": "2026-01-01T00:00:00.000Z",
"lte": "2026-01-01T00:00:00.000Z",
"notEq": "2026-01-01T00:00:00.000Z"
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"lastModified": {
"after": "text",
"before": "text",
"eq": "2026-01-01T00:00:00.000Z",
"gt": "2026-01-01T00:00:00.000Z",
"gte": "2026-01-01T00:00:00.000Z",
"lt": "2026-01-01T00:00:00.000Z",
"lte": "2026-01-01T00:00:00.000Z",
"notEq": "2026-01-01T00:00:00.000Z"
},
"or": [
{
"and": "[Circular Reference]",
"consumerName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"created": {
"after": "text",
"before": "text",
"eq": "2026-01-01T00:00:00.000Z",
"gt": "2026-01-01T00:00:00.000Z",
"gte": "2026-01-01T00:00:00.000Z",
"lt": "2026-01-01T00:00:00.000Z",
"lte": "2026-01-01T00:00:00.000Z",
"notEq": "2026-01-01T00:00:00.000Z"
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"lastModified": {
"after": "text",
"before": "text",
"eq": "2026-01-01T00:00:00.000Z",
"gt": "2026-01-01T00:00:00.000Z",
"gte": "2026-01-01T00:00:00.000Z",
"lt": "2026-01-01T00:00:00.000Z",
"lte": "2026-01-01T00:00:00.000Z",
"notEq": "2026-01-01T00:00:00.000Z"
},
"or": "[Circular Reference]",
"orderRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"preferredPickingMethods": {
"contains": {
"eq": "SINGLE_ORDER",
"in": [
"SINGLE_ORDER"
],
"notEq": "SINGLE_ORDER"
}
},
"status": {
"eq": "ABORTED",
"in": [
"ABORTED"
],
"notEq": "ABORTED"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantArticleIds": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantOrderId": "MY_ORDER_ID",
"transfers": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"exists": true
}
}
],
"orderRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"preferredPickingMethods": {
"contains": {
"eq": "SINGLE_ORDER",
"in": [
"SINGLE_ORDER"
],
"notEq": "SINGLE_ORDER"
}
},
"status": {
"eq": "ABORTED",
"in": [
"ABORTED"
],
"notEq": "ABORTED"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantArticleIds": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantOrderId": "MY_ORDER_ID",
"transfers": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"exists": true
}
},
"size": 10,
"sort": [
{
"created": "ASC",
"lastModified": "ASC",
"targetTime": "ASC",
"tenantOrderId": "ASC"
}
]
}{
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"pickJobs": [
{
"assignedUsers": [
{
"userId": "text",
"username": "text"
}
],
"customAttributes": {},
"deliveryinformation": {
"channel": "COLLECT",
"details": {
"collect": {
"identifier": "text",
"paid": false
},
"shipping": {
"carrierKey": "text",
"carrierProduct": "EXPRESS",
"carrierProductCategory": "STANDARD",
"carrierServices": [
"SIGNATURE"
],
"identifier": "text",
"invoiceAddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"postalAddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"recipientaddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"serviceLevel": "DELIVERY"
}
},
"targetTime": "2020-02-03T09:45:51.525Z",
"targetTimeBaseDate": "2020-02-03T08:45:50.525Z"
},
"expectedPickLineItems": [
{
"allowedSubstitutes": [
{
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"priority": 1,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"tenantArticleId": "text",
"title": "text"
}
],
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"partialStockLocations": [
{
"available": 21,
"location": {
"locationRef": "text",
"scannableCodes": [
"text"
]
},
"quantity": 21,
"ratingScore": 1,
"sequenceScore": 1,
"stockProperties": {
"expiry": "text"
},
"stockRef": "text",
"tenantPartialStockId": "text"
}
],
"quantity": 21,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "liter",
"secondaryQuantity": 21,
"stickers": [],
"transferId": "text",
"tags": []
},
{
"id": "climk4dcQFiPdA5ULuhS"
}
],
"facilityRef": "Esb20gpHBL94X5NdMp3C",
"operativeProcessRef": "text",
"orderDate": "2020-02-03T08:45:50.525Z",
"orderRef": "LGMl2DuvPnfPoSHhYFOm",
"paymentInformation": {
"currency": "EUR"
},
"pickingTimes": {
"startLatestAt": "2024-02-03T09:45:51.525Z"
},
"pickLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"globalLineItemId": "a81f818e-2405-4570-8cde-b0c80fd3de31",
"id": "climk4dcQFiPdA5ULuhS",
"measurementUnitKey": "liter",
"quantity": 21,
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "liter",
"secondaryQuantity": 21,
"allowedSubstitutes": [
{
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"priority": 1,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"tenantArticleId": "text",
"title": "text"
}
],
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
"partialStockLocations": [
{
"available": 21,
"location": {
"locationRef": "text",
"scannableCodes": [
"text"
]
},
"quantity": 21,
"ratingScore": 1,
"sequenceScore": 1,
"stockProperties": {
"expiry": "text"
},
"stockRef": "text",
"tenantPartialStockId": "text"
}
],
"picked": 20,
"pickedAt": "2024-02-03T08:45:51.525Z",
"pickJobLineItemRef": "12345",
"scannedCodes": [
{
"code": 1245678,
"quantity": 7
}
],
"scanningRules": {
"scanningMode": "MUST_SCAN_FIRST",
"scanningType": [
{
"priority": 1,
"scanningRuleType": "ARTICLE"
}
]
},
"secondaryPicked": 20,
"shortPickReason": {
"reasonLocalized": "{ en_US: 'SomeName' }",
"reason": "text"
},
"status": "OPEN",
"stickers": [],
"stockEmptied": true,
"substituteLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1,
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
]
},
"globalLineItemId": "text",
"id": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"partialStockLocations": [
{
"location": {
"locationRef": "text",
"scannableCodes": [
"text"
]
},
"picked": 21,
"quantity": 21,
"ratingScore": 1,
"sequenceScore": 1,
"stockProperties": {
"expiry": "text"
},
"stockRef": "text",
"tenantPartialStockId": "text",
"zoneName": "text"
}
],
"picked": 20,
"pickedAt": "2024-02-03T08:45:51.525Z",
"priority": 1,
"quantity": 21,
"refused": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "text",
"quantity": 1,
"reason": "text"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"secondaryPicked": 20,
"secondaryQuantity": 200
}
],
"tags": []
}
],
"preferredPickingMethods": [
"SINGLE_ORDER"
],
"processId": "text",
"routingPlanRef": "text",
"shortId": "AS12",
"status": "ABORTED",
"stickers": [],
"tenantOrderId": "R456728546",
"transfers": [
{
"id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
"type": "RECEIVER"
}
],
"workflowInformation": {
"instanceRef": "64c13ab08edf48a008793cac",
"isAvailable": true,
"nodeRef": "text"
},
"tags": [],
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42,
"anonymized": false,
"documentHandling": {
"sendLabel": {
"enabled": false
}
},
"documentsRef": "text",
"editor": {
"userId": "text",
"username": "text"
},
"id": "Esb20gpHBL94X5NdMp3C",
"pickingZones": [
{
"zoneRef": "text"
}
],
"pickRunRef": "text",
"resetBlocked": false,
"subStatus": "SHORT_PICKED",
"usersModificationHistory": [
{
"modificationDate": "2026-01-01T00:00:00.000Z",
"userId": "text",
"username": "text"
}
]
}
],
"total": 1
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
pickJobIdstringRequired
ID of the pickjob you want to get
Responses
200
PickJob was found & you were allowed to access it. The result is in the body.
application/json
VersionedResource
customAttributesobjectOptional
Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
facilityRefstringRequiredExample:
The id of the facility reference. The given ID has to be present in the system.
Esb20gpHBL94X5NdMp3CoperativeProcessRefstringOptional
orderDatestring · date-timeRequiredExample:
The date this order was created at the supplying system.
2020-02-03T08:45:50.525ZorderRefstringOptionalExample:
The id of the order reference. The given ID has to be present in the system.
LGMl2DuvPnfPoSHhYFOmprocessIdstringOptional
Id of the global process related to this entity. For example used for starting the GDPR process and others.
routingPlanRefstringOptional
Reference to the routingplan which created this pickjob
shortIdstringRequiredExample:
A short identifier that helps assigning a pickJob to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
The status of a pickjob.
tenantOrderIdstringOptionalExample:
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546workflowInformationone ofRequired
or
createdstring · date-timeOptionalExample:
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZlastModifiedstring · date-timeOptionalExample:
The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525Zversioninteger · int64RequiredExample:
The version of the document to be used in optimistic locking mechanisms.
42anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsedocumentsRefstringRequired
Reference to the documents collection from this entity
idstringRequiredExample:
The id of this pickjob. It is generated during creation automatically and suits as the primary identifier of the described entity.
Esb20gpHBL94X5NdMp3CpickRunRefstringOptional
Pick run id to which the pick job belongs
resetBlockedbooleanOptionalDefault:
Indicates if pickJob can still be resetted or restarted
falsestatusReasonstringOptionalDeprecated
deprecated: Use subStatus instead. Maintained for backward compatibility.
subStatusstring · enumOptionalPossible values:
The reason for the current status.
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
Entity not found
application/json
get/api/pickjobs/{pickJobId}
GET /api/pickjobs/{pickJobId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"assignedUsers": [
{
"userId": "text",
"username": "text"
}
],
"customAttributes": {},
"deliveryinformation": {
"channel": "COLLECT",
"details": {
"collect": {
"identifier": "text",
"paid": false
},
"shipping": {
"carrierKey": "text",
"carrierProduct": "EXPRESS",
"carrierProductCategory": "STANDARD",
"carrierServices": [
"SIGNATURE"
],
"identifier": "text",
"invoiceAddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"postalAddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"recipientaddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"serviceLevel": "DELIVERY"
}
},
"targetTime": "2020-02-03T09:45:51.525Z",
"targetTimeBaseDate": "2020-02-03T08:45:50.525Z"
},
"expectedPickLineItems": [
{
"allowedSubstitutes": [
{
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"priority": 1,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"tenantArticleId": "text",
"title": "text"
}
],
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"partialStockLocations": [
{
"available": 21,
"location": {
"locationRef": "text",
"scannableCodes": [
"text"
]
},
"quantity": 21,
"ratingScore": 1,
"sequenceScore": 1,
"stockProperties": {
"expiry": "text"
},
"stockRef": "text",
"tenantPartialStockId": "text"
}
],
"quantity": 21,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "liter",
"secondaryQuantity": 21,
"stickers": [],
"transferId": "text",
"tags": []
},
{
"id": "climk4dcQFiPdA5ULuhS"
}
],
"facilityRef": "Esb20gpHBL94X5NdMp3C",
"operativeProcessRef": "text",
"orderDate": "2020-02-03T08:45:50.525Z",
"orderRef": "LGMl2DuvPnfPoSHhYFOm",
"paymentInformation": {
"currency": "EUR"
},
"pickingTimes": {
"startLatestAt": "2024-02-03T09:45:51.525Z"
},
"pickLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"globalLineItemId": "a81f818e-2405-4570-8cde-b0c80fd3de31",
"id": "climk4dcQFiPdA5ULuhS",
"measurementUnitKey": "liter",
"quantity": 21,
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "liter",
"secondaryQuantity": 21,
"allowedSubstitutes": [
{
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"priority": 1,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"tenantArticleId": "text",
"title": "text"
}
],
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
"partialStockLocations": [
{
"available": 21,
"location": {
"locationRef": "text",
"scannableCodes": [
"text"
]
},
"quantity": 21,
"ratingScore": 1,
"sequenceScore": 1,
"stockProperties": {
"expiry": "text"
},
"stockRef": "text",
"tenantPartialStockId": "text"
}
],
"picked": 20,
"pickedAt": "2024-02-03T08:45:51.525Z",
"pickJobLineItemRef": "12345",
"scannedCodes": [
{
"code": 1245678,
"quantity": 7
}
],
"scanningRules": {
"scanningMode": "MUST_SCAN_FIRST",
"scanningType": [
{
"priority": 1,
"scanningRuleType": "ARTICLE"
}
]
},
"secondaryPicked": 20,
"shortPickReason": {
"reasonLocalized": "{ en_US: 'SomeName' }",
"reason": "text"
},
"status": "OPEN",
"stickers": [],
"stockEmptied": true,
"substituteLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1,
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
]
},
"globalLineItemId": "text",
"id": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"partialStockLocations": [
{
"location": {
"locationRef": "text",
"scannableCodes": [
"text"
]
},
"picked": 21,
"quantity": 21,
"ratingScore": 1,
"sequenceScore": 1,
"stockProperties": {
"expiry": "text"
},
"stockRef": "text",
"tenantPartialStockId": "text",
"zoneName": "text"
}
],
"picked": 20,
"pickedAt": "2024-02-03T08:45:51.525Z",
"priority": 1,
"quantity": 21,
"refused": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "text",
"quantity": 1,
"reason": "text"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"secondaryPicked": 20,
"secondaryQuantity": 200
}
],
"tags": []
}
],
"preferredPickingMethods": [
"SINGLE_ORDER"
],
"processId": "text",
"routingPlanRef": "text",
"shortId": "AS12",
"status": "ABORTED",
"stickers": [],
"tenantOrderId": "R456728546",
"transfers": [
{
"id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
"type": "RECEIVER"
}
],
"workflowInformation": {
"instanceRef": "64c13ab08edf48a008793cac",
"isAvailable": true,
"nodeRef": "text"
},
"tags": [],
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42,
"anonymized": false,
"documentHandling": {
"sendLabel": {
"enabled": false
}
},
"documentsRef": "text",
"editor": {
"userId": "text",
"username": "text"
},
"id": "Esb20gpHBL94X5NdMp3C",
"pickingZones": [
{
"zoneRef": "text"
}
],
"pickRunRef": "text",
"resetBlocked": false,
"subStatus": "SHORT_PICKED",
"usersModificationHistory": [
{
"modificationDate": "2026-01-01T00:00:00.000Z",
"userId": "text",
"username": "text"
}
]
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
pickJobIdstringRequired
Reference to the pick job you want to call an action for
Body
PickJobActionsParameter
or
or
or
or
or
or
or
or
or
or
or
or
or
or
or
Responses
200
Updated PickJob in the body.
application/json
VersionedResource
customAttributesobjectOptional
Attributes that can be added to the pickjob. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.
facilityRefstringRequiredExample:
The id of the facility reference. The given ID has to be present in the system.
Esb20gpHBL94X5NdMp3CoperativeProcessRefstringOptional
orderDatestring · date-timeRequiredExample:
The date this order was created at the supplying system.
2020-02-03T08:45:50.525ZorderRefstringOptionalExample:
The id of the order reference. The given ID has to be present in the system.
LGMl2DuvPnfPoSHhYFOmprocessIdstringOptional
Id of the global process related to this entity. For example used for starting the GDPR process and others.
routingPlanRefstringOptional
Reference to the routingplan which created this pickjob
shortIdstringRequiredExample:
A short identifier that helps assigning a pickJob to a customer. This is automatically created during creation.
AS12statusstring · enumRequiredPossible values:
The status of a pickjob.
tenantOrderIdstringOptionalExample:
Field can be used as a reference number in foreign systems, for example as a reference to the source system's identifier for this order.
R456728546workflowInformationone ofRequired
or
createdstring · date-timeOptionalExample:
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZlastModifiedstring · date-timeOptionalExample:
The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525Zversioninteger · int64RequiredExample:
The version of the document to be used in optimistic locking mechanisms.
42anonymizedbooleanOptionalExample:
Indicates if gdpr related data was anonymized
falsedocumentsRefstringRequired
Reference to the documents collection from this entity
idstringRequiredExample:
The id of this pickjob. It is generated during creation automatically and suits as the primary identifier of the described entity.
Esb20gpHBL94X5NdMp3CpickRunRefstringOptional
Pick run id to which the pick job belongs
resetBlockedbooleanOptionalDefault:
Indicates if pickJob can still be resetted or restarted
falsestatusReasonstringOptionalDeprecated
deprecated: Use subStatus instead. Maintained for backward compatibility.
subStatusstring · enumOptionalPossible values:
The reason for the current status.
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
post/api/pickjobs/{pickJobId}/actions
POST /api/pickjobs/{pickJobId}/actions HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"name": "ABORT",
"version": 1
}{
"assignedUsers": [
{
"userId": "text",
"username": "text"
}
],
"customAttributes": {},
"deliveryinformation": {
"channel": "COLLECT",
"details": {
"collect": {
"identifier": "text",
"paid": false
},
"shipping": {
"carrierKey": "text",
"carrierProduct": "EXPRESS",
"carrierProductCategory": "STANDARD",
"carrierServices": [
"SIGNATURE"
],
"identifier": "text",
"invoiceAddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"postalAddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"recipientaddress": {
"addressType": "POSTAL_ADDRESS",
"companyName": "Speedy Boxales Ltd.",
"coordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"email": "test@try.de",
"firstName": "Maxine",
"lastName": "Muller",
"personalTitle": "Dr.",
"salutation": "Frau",
"additionalAddressInfo": "to care of: Mrs. Müller",
"city": "Langenfeld",
"country": "DE",
"customAttributes": {},
"houseNumber": "42a",
"phoneNumbers": [
{
"customAttributes": {},
"label": "text",
"type": "MOBILE",
"value": "text"
}
],
"postalCode": "40764",
"province": "NRW",
"street": "Hauptstr."
},
"serviceLevel": "DELIVERY"
}
},
"targetTime": "2020-02-03T09:45:51.525Z",
"targetTimeBaseDate": "2020-02-03T08:45:50.525Z"
},
"expectedPickLineItems": [
{
"allowedSubstitutes": [
{
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"priority": 1,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"tenantArticleId": "text",
"title": "text"
}
],
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"partialStockLocations": [
{
"available": 21,
"location": {
"locationRef": "text",
"scannableCodes": [
"text"
]
},
"quantity": 21,
"ratingScore": 1,
"sequenceScore": 1,
"stockProperties": {
"expiry": "text"
},
"stockRef": "text",
"tenantPartialStockId": "text"
}
],
"quantity": 21,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "liter",
"secondaryQuantity": 21,
"stickers": [],
"transferId": "text",
"tags": []
},
{
"id": "climk4dcQFiPdA5ULuhS"
}
],
"facilityRef": "Esb20gpHBL94X5NdMp3C",
"operativeProcessRef": "text",
"orderDate": "2020-02-03T08:45:50.525Z",
"orderRef": "LGMl2DuvPnfPoSHhYFOm",
"paymentInformation": {
"currency": "EUR"
},
"pickingTimes": {
"startLatestAt": "2024-02-03T09:45:51.525Z"
},
"pickLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"customAttributes": {},
"globalLineItemId": "a81f818e-2405-4570-8cde-b0c80fd3de31",
"id": "climk4dcQFiPdA5ULuhS",
"measurementUnitKey": "liter",
"quantity": 21,
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "liter",
"secondaryQuantity": 21,
"allowedSubstitutes": [
{
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"priority": 1,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"tenantArticleId": "text",
"title": "text"
}
],
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
"partialStockLocations": [
{
"available": 21,
"location": {
"locationRef": "text",
"scannableCodes": [
"text"
]
},
"quantity": 21,
"ratingScore": 1,
"sequenceScore": 1,
"stockProperties": {
"expiry": "text"
},
"stockRef": "text",
"tenantPartialStockId": "text"
}
],
"picked": 20,
"pickedAt": "2024-02-03T08:45:51.525Z",
"pickJobLineItemRef": "12345",
"scannedCodes": [
{
"code": 1245678,
"quantity": 7
}
],
"scanningRules": {
"scanningMode": "MUST_SCAN_FIRST",
"scanningType": [
{
"priority": 1,
"scanningRuleType": "ARTICLE"
}
]
},
"secondaryPicked": 20,
"shortPickReason": {
"reasonLocalized": "{ en_US: 'SomeName' }",
"reason": "text"
},
"status": "OPEN",
"stickers": [],
"stockEmptied": true,
"substituteLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"customAttributes": {},
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1,
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
]
},
"globalLineItemId": "text",
"id": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"partialStockLocations": [
{
"location": {
"locationRef": "text",
"scannableCodes": [
"text"
]
},
"picked": 21,
"quantity": 21,
"ratingScore": 1,
"sequenceScore": 1,
"stockProperties": {
"expiry": "text"
},
"stockRef": "text",
"tenantPartialStockId": "text",
"zoneName": "text"
}
],
"picked": 20,
"pickedAt": "2024-02-03T08:45:51.525Z",
"priority": 1,
"quantity": 21,
"refused": [
{
"reasonLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"comment": "text",
"quantity": 1,
"reason": "text"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"secondaryPicked": 20,
"secondaryQuantity": 200
}
],
"tags": []
}
],
"preferredPickingMethods": [
"SINGLE_ORDER"
],
"processId": "text",
"routingPlanRef": "text",
"shortId": "AS12",
"status": "ABORTED",
"stickers": [],
"tenantOrderId": "R456728546",
"transfers": [
{
"id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
"type": "RECEIVER"
}
],
"workflowInformation": {
"instanceRef": "64c13ab08edf48a008793cac",
"isAvailable": true,
"nodeRef": "text"
},
"tags": [],
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42,
"anonymized": false,
"documentHandling": {
"sendLabel": {
"enabled": false
}
},
"documentsRef": "text",
"editor": {
"userId": "text",
"username": "text"
},
"id": "Esb20gpHBL94X5NdMp3C",
"pickingZones": [
{
"zoneRef": "text"
}
],
"pickRunRef": "text",
"resetBlocked": false,
"subStatus": "SHORT_PICKED",
"usersModificationHistory": [
{
"modificationDate": "2026-01-01T00:00:00.000Z",
"userId": "text",
"username": "text"
}
]
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
pickJobIdstringRequired
ID of the pick job for which you want to get a deliverynote
Query parameters
localestringOptional
Provide the localized values for the delivery note. If not provided the default locale is used. For example de_DE
Responses
200
The deliverynote for the given pickjob
application/pdf
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
Entity not found
application/json
get/api/pickjobs/{pickJobId}/deliverynote
GET /api/pickjobs/{pickJobId}/deliverynote HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
pickJobIdstringRequired
ID of the pick job you want to get document handling information
Responses
200
Pick job document handling was found & you were allowed to access it. The result is in the body.
application/json
DocumentHandling
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
Entity not found
application/json
get/api/pickjobs/{pickJobId}/documenthandling
GET /api/pickjobs/{pickJobId}/documenthandling HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"sendLabel": {
"enabled": false
}
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
pickJobIdstringRequired
ID of the pick job for which you want to get a transfer label
Responses
200
The transfer label for the given pickjob
application/pdf
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
Entity not found
application/json
get/api/pickjobs/{pickJobId}/transferlabel
GET /api/pickjobs/{pickJobId}/transferlabel HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Create new load units for the given pick job
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
pickJobIdstringRequired
Body
PickingLoadUnitForCreation
codesstring[] · min: 1 · max: 100Required
List of codes
customAttributesobject · nullableOptional
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.
loadUnitTypeRefstringOptionalDeprecatedExample:
Use operativeContainerTypeRef instead.
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2foperativeContainerTypeRefstringOptionalExample:
the reference to the operativeContainerType
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fstackRefstringOptionalExample:
the reference to the stackRef this loadUnit is part of
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fstorageLocationRefstringOptionalExample:
the reference to the storage location this load unit as been placed into
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fResponses
201
The load units was successfully created.
application/json
LoadUnit
codesstring[] · max: 100Optional
List of codes
createdstring · date-timeRequiredExample:
Creation timestamp
2026-06-17T12:00:00.000ZcustomAttributesobject · nullableOptional
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.
descriptionstringOptional
facilityRefstringRequiredExample:
The id of the facility reference. The given ID has to be present in the system. But it is not updatable via PUT request
Esb20gpHBL94X5NdMp3CiconUrlstringOptional
idstringRequiredExample:
Unique identifier for the load unit
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2flastModifiedstring · date-timeRequiredExample:
Last modification timestamp
2026-06-17T12:00:00.000ZloadUnitTypeRefstringOptionalDeprecatedExample:
Use operativeContainerTypeRef instead.
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fnamestringOptional
operativeContainerTypeRefstringOptionalExample:
the reference to the operativeContainerType
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2foperativeProcessRefstring · min: 1OptionalExample:
Reference to related operative process
019f5b8e-d580-767f-a28d-3fe569bd0064pickJobRefsstring[] · min: 1 · max: 100RequiredExample:
List of corresponding pickjob Ids
["0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f","0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"]stackRefstringOptionalExample:
the reference to the stackRef this loadUnit is part of
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fstatusstring · enumRequiredDefault:
The status of the load unit. It can be AVAILABLE or OBSOLETE. The status cannot be set from outside. When a load unit is created, it is automatically set to AVAILABLE. When a load unit is deleted, it is automatically set to OBSOLETE.
AVAILABLEExample: AVAILABLEPossible values: storageLocationRefstringOptionalExample:
the reference to the storage location this load unit as been placed into
0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2fversionintegerRequiredExample:
Version number for optimistic locking
1weightLimitInGnumber · min: 1Optional
Maximal weight in gramm(gr) the loadunit can handle.
400
Invalid input. See response for details.
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
The requested entity was not found
application/json
post/api/pickjobs/{pickJobId}/loadunits
POST /api/pickjobs/{pickJobId}/loadunits HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1719
{
"codes": [
"text"
],
"customAttributes": {},
"loadUnitLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "text",
"title": "text",
"weight": 1
},
"customAttributes": {},
"globalLineItemIds": [
"text"
],
"measurementUnitKey": "liter",
"quantity": 1,
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"recordingRule": "MANDATORY",
"validations": [
{
"allowedValues": [
{
"type": "STRING"
}
],
"type": "EXACT_MATCH"
}
],
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "g",
"secondaryQuantity": 1,
"substituteForOrderedItem": {
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"globalLineItemId": "text"
}
}
],
"operativeContainerTypeRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stackRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}{
"nameLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"descriptionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"codes": [
"text"
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"description": "text",
"dimensions": {
"heightInCm": 50,
"lengthInCm": 100,
"weightInG": 1700,
"widthInCm": 25
},
"facilityRef": "Esb20gpHBL94X5NdMp3C",
"iconUrl": "text",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"lastModified": "2026-06-17T12:00:00.000Z",
"loadUnitLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "text",
"title": "text",
"weight": 1
},
"customAttributes": {},
"globalLineItemIds": [
"text"
],
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"measurementUnitKey": "liter",
"originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
"quantity": 1,
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "g",
"secondaryQuantity": 1,
"substituteForOrderedItem": {
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"globalLineItemId": "text"
}
}
],
"name": "text",
"operativeContainerTypeRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"operativeProcessRef": "019f5b8e-d580-767f-a28d-3fe569bd0064",
"pickJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stackRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"status": "AVAILABLE",
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"version": 1,
"weightLimitInG": 1
}Get all load units for the given pick job
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
pickJobIdstringRequired
Responses
200
Loadunits were found. The results are in the body.
application/json
LoadUnits
totalintegerRequiredExample:
Total number of found entities for this query
42401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
The requested entity was not found
application/json
get/api/pickjobs/{pickJobId}/loadunits
GET /api/pickjobs/{pickJobId}/loadunits HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"loadUnits": [
{
"nameLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"descriptionLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"codes": [
"text"
],
"created": "2026-06-17T12:00:00.000Z",
"customAttributes": {},
"description": "text",
"dimensions": {
"heightInCm": 50,
"lengthInCm": 100,
"weightInG": 1700,
"widthInCm": 25
},
"facilityRef": "Esb20gpHBL94X5NdMp3C",
"iconUrl": "text",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"lastModified": "2026-06-17T12:00:00.000Z",
"loadUnitLineItems": [
{
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"customAttributes": {},
"imageUrl": "text",
"tenantArticleId": "text",
"title": "text",
"weight": 1
},
"customAttributes": {},
"globalLineItemIds": [
"text"
],
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"measurementUnitKey": "liter",
"originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
"quantity": 1,
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"group": "general",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"key": "country of origin",
"originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "g",
"secondaryQuantity": 1,
"substituteForOrderedItem": {
"article": {
"titleLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "https://example.com/resource",
"tenantArticleId": "4711",
"title": "Cologne Water",
"weight": 1
},
"globalLineItemId": "text"
}
}
],
"name": "text",
"operativeContainerTypeRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"operativeProcessRef": "019f5b8e-d580-767f-a28d-3fe569bd0064",
"pickJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"stackRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"status": "AVAILABLE",
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"version": 1,
"weightLimitInG": 1
}
],
"total": 42
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
pickjobIdstringRequired
ID of the Pickjob
Responses
200
Returns a return note for the pickjob.
application/pdf
401
Your user is not allowed to operate against this API instance
application/pdf
403
Your user, although recognized, is not authorized to use this endpoint
application/pdf
404
Entity not found
application/pdf
get/api/pickjobs/{pickjobId}/returnnote
GET /api/pickjobs/{pickjobId}/returnnote HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200
pickjob tag config is in response body.
application/json
PickJobTagConfiguration
createdstring · date-timeOptionalExample:
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZlastModifiedstring · date-timeOptionalExample:
The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525Zversioninteger · int64RequiredExample:
The version of the document to be used in optimistic locking mechanisms.
42401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
404
Entity not found
application/json
get/api/configurations/tags/pickjob
GET /api/configurations/tags/pickjob HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"lineItemScanningConfiguration": {
"offeredScanningRuleByTag": [
{
"matchingValues": [
"text"
],
"scanningType": "MUST_SCAN_FIRST",
"tagRef": "text"
}
]
},
"lineItemStickerConfiguration": {
"offeredStickersByTag": [
{
"matchingValues": [
"text"
],
"stickers": [],
"tagRef": "text"
}
]
},
"offeredDocumentsByDefault": [
{
"documentCategory": "EXTERNAL"
}
],
"offeredDocumentsPerTag": [
{
"matchingValues": [
"text"
],
"offeredDocuments": [
{
"documentCategory": "EXTERNAL"
}
],
"tagRef": "text"
}
],
"preferredPickingMethodsConfiguration": {
"PreferredPickingMethodsPerTag": []
},
"stickerConfiguration": {
"offeredStickersByTag": [
{
"matchingValues": [
"text"
],
"stickers": [],
"tagRef": "text"
}
]
},
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
PickJobTagConfiguration
createdstring · date-timeOptionalExample:
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZlastModifiedstring · date-timeOptionalExample:
The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525Zversioninteger · int64RequiredExample:
The version of the document to be used in optimistic locking mechanisms.
42Responses
200
The packing configuration was successfully updated.
application/json
PickJobTagConfiguration
createdstring · date-timeOptionalExample:
The date this entity was created at the platform. This value is generated by the service.
2020-02-03T08:45:51.525ZlastModifiedstring · date-timeOptionalExample:
The date this entity was modified last. This value is generated by the service.
2020-02-03T09:45:51.525Zversioninteger · int64RequiredExample:
The version of the document to be used in optimistic locking mechanisms.
42400
Invalid input. See response for details
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
put/api/configurations/tags/pickjob
PUT /api/configurations/tags/pickjob HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 719
{
"lineItemScanningConfiguration": {
"offeredScanningRuleByTag": [
{
"matchingValues": [
"text"
],
"scanningType": "MUST_SCAN_FIRST",
"tagRef": "text"
}
]
},
"lineItemStickerConfiguration": {
"offeredStickersByTag": [
{
"matchingValues": [
"text"
],
"stickers": [],
"tagRef": "text"
}
]
},
"offeredDocumentsByDefault": [
{
"documentCategory": "EXTERNAL"
}
],
"offeredDocumentsPerTag": [
{
"matchingValues": [
"text"
],
"offeredDocuments": [
{
"documentCategory": "EXTERNAL"
}
],
"tagRef": "text"
}
],
"preferredPickingMethodsConfiguration": {
"PreferredPickingMethodsPerTag": []
},
"stickerConfiguration": {
"offeredStickersByTag": [
{
"matchingValues": [
"text"
],
"stickers": [],
"tagRef": "text"
}
]
},
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42
}{
"lineItemScanningConfiguration": {
"offeredScanningRuleByTag": [
{
"matchingValues": [
"text"
],
"scanningType": "MUST_SCAN_FIRST",
"tagRef": "text"
}
]
},
"lineItemStickerConfiguration": {
"offeredStickersByTag": [
{
"matchingValues": [
"text"
],
"stickers": [],
"tagRef": "text"
}
]
},
"offeredDocumentsByDefault": [
{
"documentCategory": "EXTERNAL"
}
],
"offeredDocumentsPerTag": [
{
"matchingValues": [
"text"
],
"offeredDocuments": [
{
"documentCategory": "EXTERNAL"
}
],
"tagRef": "text"
}
],
"preferredPickingMethodsConfiguration": {
"PreferredPickingMethodsPerTag": []
},
"stickerConfiguration": {
"offeredStickersByTag": [
{
"matchingValues": [
"text"
],
"stickers": [],
"tagRef": "text"
}
]
},
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42
}Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
pickRunIdstringRequired
id of pickRun
Body
PickRunPickJobsPatchAction
versioninteger · int64RequiredExample:
The version of the document to be used in optimistic locking mechanisms.
42Responses
200
Pick job was successfully from pick run removed.
No content
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
patch/api/pickruns/{pickRunId}/pickjobs
PATCH /api/pickruns/{pickRunId}/pickjobs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 27
{
"actions": [],
"version": 42
}No content
This part of the API is in Beta status. For details, see the API release lifecycle documentation. Returns all available substitutes for a given pickLineItem.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
pickJobIdstringRequired
Reference to the pick job you to get the available substitutes for
pickLineItemIdstringRequired
Reference to the pickLineItem you to get the available substitutes for
Responses
200
Available substitutes for given pickLineItem
application/json
ResolvedSubstitutes
tenantArticleIdstringRequired
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
get/api/pickjobs/{pickJobId}/picklineitems/{pickLineItemId}/availablesubstitutes
GET /api/pickjobs/{pickJobId}/picklineitems/{pickLineItemId}/availablesubstitutes HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"substitutes": [
{
"attributes": [
{
"valueLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"category": "descriptive",
"context": {
"type": "FACILITY_GROUP",
"value": "text"
},
"key": "%%subtitle%%",
"priority": 100,
"type": "STRING",
"value": "585er Gold"
}
],
"imageUrl": "text",
"measurementUnitKey": "liter",
"measurementValidation": {
"overPickHardTolerancePercentage": 20,
"overPickSoftTolerancePercentage": 15,
"shortPickHardTolerancePercentage": 15,
"shortPickSoftTolerancePercentage": 10
},
"priority": 1,
"scannableCodes": [
"text"
],
"secondaryMeasurementUnitKey": "gram",
"tenantArticleId": "text",
"title": "text"
}
],
"tenantArticleId": "text"
}Last updated
Was this helpful?