Search endpoints
Search for Role
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
RoleSearchPayload
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
RolePaginatedResult
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/roles/search
POST /api/roles/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1475
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"description": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"displayName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]"
}
],
"description": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"displayName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"and": "[Circular Reference]",
"description": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"displayName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]"
}
]
}
],
"description": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"displayName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"and": "[Circular Reference]",
"description": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"displayName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]"
}
]
},
"size": 10,
"sort": [
{
"displayName": "ASC"
}
]
}{
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"roles": [
{
"context": [
{
"type": "FACILITY",
"values": [
"text"
]
}
],
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"description": "text",
"displayName": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"name": "text",
"permissions": [
"USER_READ"
],
"version": 1
}
],
"total": 1
}This part of the API is in Beta status. For details, see the API release lifecycle documentation. Search for User
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
UserSearchPayload
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
UserPaginatedResult
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/users/search
POST /api/users/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6243
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"assignedFacilities": {
"contains": {
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"exists": true
},
"assignedRoles": {
"contains": {
"context": {
"contains": {
"type": {
"eq": "FACILITY",
"in": [
"FACILITY"
],
"notEq": "FACILITY"
},
"values": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"ref": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"auth": {
"type": {
"eq": "EMAIL_PASSWORD",
"in": [
"EMAIL_PASSWORD"
],
"notEq": "EMAIL_PASSWORD"
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"customClaims": {
"roles": {
"contains": {
"facilities": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"name": {
"eq": "FULFILLER",
"in": [
"FULFILLER"
],
"notEq": "FULFILLER"
}
},
"exists": true
}
},
"facilityLimitations": {
"contains": {
"eq": "text",
"notEq": "text"
},
"exists": true
},
"firstname": "Phil",
"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"
},
"lastname": "Bison",
"or": "[Circular Reference]",
"username": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
],
"assignedFacilities": {
"contains": {
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"exists": true
},
"assignedRoles": {
"contains": {
"context": {
"contains": {
"type": {
"eq": "FACILITY",
"in": [
"FACILITY"
],
"notEq": "FACILITY"
},
"values": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"ref": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"auth": {
"type": {
"eq": "EMAIL_PASSWORD",
"in": [
"EMAIL_PASSWORD"
],
"notEq": "EMAIL_PASSWORD"
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"customClaims": {
"roles": {
"contains": {
"facilities": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"name": {
"eq": "FULFILLER",
"in": [
"FULFILLER"
],
"notEq": "FULFILLER"
}
},
"exists": true
}
},
"facilityLimitations": {
"contains": {
"eq": "text",
"notEq": "text"
},
"exists": true
},
"firstname": "Phil",
"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"
},
"lastname": "Bison",
"or": [
{
"and": "[Circular Reference]",
"assignedFacilities": {
"contains": {
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"exists": true
},
"assignedRoles": {
"contains": {
"context": {
"contains": {
"type": {
"eq": "FACILITY",
"in": [
"FACILITY"
],
"notEq": "FACILITY"
},
"values": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"ref": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"auth": {
"type": {
"eq": "EMAIL_PASSWORD",
"in": [
"EMAIL_PASSWORD"
],
"notEq": "EMAIL_PASSWORD"
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"customClaims": {
"roles": {
"contains": {
"facilities": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"name": {
"eq": "FULFILLER",
"in": [
"FULFILLER"
],
"notEq": "FULFILLER"
}
},
"exists": true
}
},
"facilityLimitations": {
"contains": {
"eq": "text",
"notEq": "text"
},
"exists": true
},
"firstname": "Phil",
"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"
},
"lastname": "Bison",
"or": "[Circular Reference]",
"username": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
],
"username": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
],
"assignedFacilities": {
"contains": {
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"exists": true
},
"assignedRoles": {
"contains": {
"context": {
"contains": {
"type": {
"eq": "FACILITY",
"in": [
"FACILITY"
],
"notEq": "FACILITY"
},
"values": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"ref": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"auth": {
"type": {
"eq": "EMAIL_PASSWORD",
"in": [
"EMAIL_PASSWORD"
],
"notEq": "EMAIL_PASSWORD"
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"customClaims": {
"roles": {
"contains": {
"facilities": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"name": {
"eq": "FULFILLER",
"in": [
"FULFILLER"
],
"notEq": "FULFILLER"
}
},
"exists": true
}
},
"facilityLimitations": {
"contains": {
"eq": "text",
"notEq": "text"
},
"exists": true
},
"firstname": "Phil",
"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"
},
"lastname": "Bison",
"or": [
{
"and": "[Circular Reference]",
"assignedFacilities": {
"contains": {
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"exists": true
},
"assignedRoles": {
"contains": {
"context": {
"contains": {
"type": {
"eq": "FACILITY",
"in": [
"FACILITY"
],
"notEq": "FACILITY"
},
"values": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"ref": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"auth": {
"type": {
"eq": "EMAIL_PASSWORD",
"in": [
"EMAIL_PASSWORD"
],
"notEq": "EMAIL_PASSWORD"
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"customClaims": {
"roles": {
"contains": {
"facilities": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"name": {
"eq": "FULFILLER",
"in": [
"FULFILLER"
],
"notEq": "FULFILLER"
}
},
"exists": true
}
},
"facilityLimitations": {
"contains": {
"eq": "text",
"notEq": "text"
},
"exists": true
},
"firstname": "Phil",
"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"
},
"lastname": "Bison",
"or": "[Circular Reference]",
"username": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
],
"username": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"size": 10,
"sort": [
{
"assignedRoles": {
"ref": "ASC"
},
"authenticationProvider": {
"type": "ASC"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"firstname": "ASC",
"lastLogin": "ASC",
"lastname": "ASC",
"username": "ASC"
}
]
}{
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1,
"users": [
{
"assignedRoles": [
{
"context": [
{
"type": "FACILITY",
"values": [
"text"
]
}
],
"ref": "text"
}
],
"authenticationProvider": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"type": "EMAIL_PASSWORD"
},
"authenticationProviderType": "de_DE",
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"email": "john.doe@example.com",
"facilityLimitations": [
"text"
],
"firstname": "John",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"lastLogin": "2026-01-01T00:00:00.000Z",
"lastModified": "2026-01-01T00:00:00.000Z",
"lastname": "Doe",
"locale": "de_DE",
"username": "johndoe",
"version": 1
}
]
}Search for Zone
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ZoneSearchPayload
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
ZonePaginatedResult
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/zones/search
POST /api/zones/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1511
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]"
}
],
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"and": "[Circular Reference]",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]"
}
]
}
],
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"and": "[Circular Reference]",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]"
}
]
},
"size": 10,
"sort": [
{
"lastModified": "ASC"
}
]
}{
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1,
"zones": [
{
"version": 42,
"name": "text",
"score": 1,
"customAttributes": {},
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z"
}
]
}Search for Stock
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
StockSearchPayload
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
StockPaginatedResult
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/stocks/search
POST /api/stocks/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5493
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"availableUntil": {
"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"
},
"conditions": {
"contains": {
"eq": "DEFECTIVE",
"in": [
"DEFECTIVE"
],
"notEq": "DEFECTIVE"
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"properties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"receiptDate": "2026-06-17T12:00:00.000Z",
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantArticleId": "MY_ARTICLE_ID",
"tenantFacilityId": "MY_FACILITY_ID",
"tenantStockId": "MY_STOCK_ID",
"traits": {
"contains": {
"eq": "PICKABLE",
"in": [
"PICKABLE"
],
"notEq": "PICKABLE"
}
},
"value": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
}
}
],
"availableUntil": {
"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"
},
"conditions": {
"contains": {
"eq": "DEFECTIVE",
"in": [
"DEFECTIVE"
],
"notEq": "DEFECTIVE"
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": [
{
"and": "[Circular Reference]",
"availableUntil": {
"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"
},
"conditions": {
"contains": {
"eq": "DEFECTIVE",
"in": [
"DEFECTIVE"
],
"notEq": "DEFECTIVE"
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"properties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"receiptDate": "2026-06-17T12:00:00.000Z",
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantArticleId": "MY_ARTICLE_ID",
"tenantFacilityId": "MY_FACILITY_ID",
"tenantStockId": "MY_STOCK_ID",
"traits": {
"contains": {
"eq": "PICKABLE",
"in": [
"PICKABLE"
],
"notEq": "PICKABLE"
}
},
"value": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
}
}
],
"properties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"receiptDate": "2026-06-17T12:00:00.000Z",
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantArticleId": "MY_ARTICLE_ID",
"tenantFacilityId": "MY_FACILITY_ID",
"tenantStockId": "MY_STOCK_ID",
"traits": {
"contains": {
"eq": "PICKABLE",
"in": [
"PICKABLE"
],
"notEq": "PICKABLE"
}
},
"value": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
}
}
],
"availableUntil": {
"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"
},
"conditions": {
"contains": {
"eq": "DEFECTIVE",
"in": [
"DEFECTIVE"
],
"notEq": "DEFECTIVE"
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": [
{
"and": "[Circular Reference]",
"availableUntil": {
"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"
},
"conditions": {
"contains": {
"eq": "DEFECTIVE",
"in": [
"DEFECTIVE"
],
"notEq": "DEFECTIVE"
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"properties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"receiptDate": "2026-06-17T12:00:00.000Z",
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantArticleId": "MY_ARTICLE_ID",
"tenantFacilityId": "MY_FACILITY_ID",
"tenantStockId": "MY_STOCK_ID",
"traits": {
"contains": {
"eq": "PICKABLE",
"in": [
"PICKABLE"
],
"notEq": "PICKABLE"
}
},
"value": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
}
}
],
"properties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"receiptDate": "2026-06-17T12:00:00.000Z",
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantArticleId": "MY_ARTICLE_ID",
"tenantFacilityId": "MY_FACILITY_ID",
"tenantStockId": "MY_STOCK_ID",
"traits": {
"contains": {
"eq": "PICKABLE",
"in": [
"PICKABLE"
],
"notEq": "PICKABLE"
}
},
"value": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
}
},
"size": 10,
"sort": [
{
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lastModified": "ASC",
"locationName": "ASC",
"tenantArticleId": "ASC",
"value": "ASC"
}
]
}{
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"stocks": [
{
"available": 1,
"availableUntil": "2026-01-01T00:00:00.000Z",
"conditions": [
"DEFECTIVE"
],
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"facility": {
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantFacilityId": "MY_FACILITY_ID"
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"locationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"properties": {
"expiry": "text"
},
"receiptDate": "2026-06-17T12:00:00.000Z",
"scannableCodes": [
"text"
],
"scores": [
{
"scoreName": "ZONE",
"scoreType": "RATING",
"scoreValue": 1
}
],
"serializedProperties": "text",
"tenantArticleId": "MY_ARTICLE_ID",
"tenantStockId": "MY_STOCK_ID",
"traitConfig": [
{
"enabled": true,
"trait": "text"
}
],
"traits": [
"PICKABLE"
],
"value": 42,
"version": 1
}
],
"total": 1
}Search for Parcel
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ParcelSearchPayload
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
ParcelPaginatedResult
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/parcels/search
POST /api/parcels/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 8982
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"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",
"invoice": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"items": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"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]",
"recipient": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"result": {
"carrierTrackingNumber": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"shortId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantOrderId": "MY_ORDER_ID"
}
],
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"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",
"invoice": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"items": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"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]",
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"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",
"invoice": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"items": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"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]",
"recipient": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"result": {
"carrierTrackingNumber": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"shortId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantOrderId": "MY_ORDER_ID"
}
],
"recipient": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"result": {
"carrierTrackingNumber": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"shortId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantOrderId": "MY_ORDER_ID"
}
],
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"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",
"invoice": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"items": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"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]",
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"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",
"invoice": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"items": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"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]",
"recipient": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"result": {
"carrierTrackingNumber": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"shortId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantOrderId": "MY_ORDER_ID"
}
],
"recipient": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"result": {
"carrierTrackingNumber": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"shortId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantOrderId": "MY_ORDER_ID"
},
"size": 10,
"sort": [
{
"created": "ASC",
"lastModified": "ASC"
}
]
}{
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"parcels": [
{
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42,
"sequenceNumber": 100,
"anonymized": false,
"carrierInformation": {
"shippingContainerNumber": "123456-ABC"
},
"carrierProduct": "EXPRESS",
"carrierRef": "cf00e102-34f2-45c1-a846-6a21f384321e",
"customAttributes": {},
"customProductValue": 12.5,
"dimensions": {
"customWeight": 1,
"height": 1,
"length": 1,
"weight": 1,
"width": 1
},
"documentsRef": "text",
"facilityRef": "text",
"id": "95EWrieX09OmeriXIUbb",
"invoice": {
"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."
},
"items": [
{
"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"
}
]
},
"customAttributes": {},
"globalLineItemId": "text",
"id": "ae3ba67c-a42c-4816-96ac-16231e49640c",
"measurementUnitKey": "pcs",
"quantity": 5,
"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": 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"
},
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"originId": "df671041-10dd-4600-a2ff-e9ffe2556bba"
}
],
"loadUnitRefs": [
"text"
],
"operativeProcessRef": "text",
"paymentInformation": {
"currency": "EUR"
},
"pickUpInformation": {
"endTime": "2026-01-01T00:00:00.000Z",
"startTime": "2026-01-01T00:00:00.000Z"
},
"postalCharges": {
"currency": "EUR",
"value": 15.5
},
"processRef": "text",
"productValue": 1250,
"productValueCurrency": {
"currency": "EUR",
"decimalPlaces": 2
},
"productValueType": "INSURANCE",
"recipient": {
"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."
},
"result": {
"carrierParcelRef": "84168117830018",
"carrierTrackingNumber": "84168117830018",
"carrierTrackingStatus": "registered",
"customsDocumentId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
"customsDocumentUrl": "someCepProvider.com/pathToReturnLabel.pdf",
"errors": {
"labelError": "text",
"returnLabelError": "text"
},
"labelUrl": "%%HOST%%/api/parcels/{parcelId}/labels/84168117830018.pdf",
"proxyId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
"returnLabelId": "3a186c51d4281acbecf5ed38805b1db92a9d668b",
"returnLabelUrl": "someCepProvider.com/pathToReturnLabel.pdf",
"returnTrackingUrl": "http://track.io/3a186c51d4",
"sendLabelUrl": "someCepProvider.com/pathToSendLabel.pdf",
"summary": "Package label was successfully requested at DHL.",
"trackingStatus": "registered",
"trackingUrl": "http://track.io/3a186c51d4"
},
"returnAddress": {
"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.",
"companyName": "Speedy Boxales Ltd.",
"emailAddresses": [
{
"recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
"value": "text"
}
],
"resolvedCoordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"resolvedTimeZone": {
"offsetInSeconds": 28800,
"source": "Google Maps API",
"timeZoneId": "America/Los_Angeles",
"timeZoneName": "Pacific Standard Time"
}
},
"sender": {
"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.",
"companyName": "Speedy Boxales Ltd.",
"emailAddresses": [
{
"recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
"value": "text"
}
],
"resolvedCoordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"resolvedTimeZone": {
"offsetInSeconds": 28800,
"source": "Google Maps API",
"timeZoneId": "America/Los_Angeles",
"timeZoneName": "Pacific Standard Time"
}
},
"services": {
"additionalTransportInsurance": true,
"adultSignature": true,
"bulkyGoods": true,
"customerSignature": true,
"handoverToRecipientOnly": true,
"identityAgeCheck18": true,
"identityCheckCompany": true,
"identityCheckPrivate": true,
"noNeighborDelivery": true,
"saturdayDelivery": true,
"signature": true
},
"shipmentRef": "95EWrieX09OmeriXIUbb",
"shortId": "AA12-1",
"status": "OPEN",
"tenantOrderId": "R456728546",
"tenantParcelId": "MY-PARCEL-12345",
"transfers": [
{
"id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
"type": "RECEIVER"
}
],
"workflowInformation": {
"instanceRef": "64c13ab08edf48a008793cac",
"isAvailable": true,
"nodeRef": "text"
}
}
],
"total": 1
}Search for Listing
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ListingSearchPayload
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
ListingPaginatedResult
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/listings/search
POST /api/listings/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5903
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"availabilityTimeframe": "2026-06-17T12:00:00.000Z",
"categoryRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"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"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"measurementUnitKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"outOfStockBehaviour": {
"eq": "NONE",
"in": [
"NONE"
],
"notEq": "NONE"
},
"price": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"status": {
"eq": "ACTIVE",
"in": [
"ACTIVE"
],
"notEq": "ACTIVE"
},
"tenantArticleId": "MY_ARTICLE_ID",
"weight": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"tags": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"value": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"availabilityTimeframe": "2026-06-17T12:00:00.000Z",
"categoryRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"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"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"measurementUnitKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"and": "[Circular Reference]",
"availabilityTimeframe": "2026-06-17T12:00:00.000Z",
"categoryRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"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"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"measurementUnitKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"outOfStockBehaviour": {
"eq": "NONE",
"in": [
"NONE"
],
"notEq": "NONE"
},
"price": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"status": {
"eq": "ACTIVE",
"in": [
"ACTIVE"
],
"notEq": "ACTIVE"
},
"tenantArticleId": "MY_ARTICLE_ID",
"weight": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"tags": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"value": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"outOfStockBehaviour": {
"eq": "NONE",
"in": [
"NONE"
],
"notEq": "NONE"
},
"price": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"status": {
"eq": "ACTIVE",
"in": [
"ACTIVE"
],
"notEq": "ACTIVE"
},
"tenantArticleId": "MY_ARTICLE_ID",
"weight": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"tags": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"value": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"availabilityTimeframe": "2026-06-17T12:00:00.000Z",
"categoryRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"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"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"measurementUnitKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"and": "[Circular Reference]",
"availabilityTimeframe": "2026-06-17T12:00:00.000Z",
"categoryRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"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"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"measurementUnitKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"outOfStockBehaviour": {
"eq": "NONE",
"in": [
"NONE"
],
"notEq": "NONE"
},
"price": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"status": {
"eq": "ACTIVE",
"in": [
"ACTIVE"
],
"notEq": "ACTIVE"
},
"tenantArticleId": "MY_ARTICLE_ID",
"weight": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"tags": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"value": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"outOfStockBehaviour": {
"eq": "NONE",
"in": [
"NONE"
],
"notEq": "NONE"
},
"price": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"status": {
"eq": "ACTIVE",
"in": [
"ACTIVE"
],
"notEq": "ACTIVE"
},
"tenantArticleId": "MY_ARTICLE_ID",
"weight": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"tags": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"value": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
},
"size": 10,
"sort": [
{
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lastModified": "ASC",
"tenantArticleId": "ASC"
}
]
}{
"listings": [
{
"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"
}
],
"categoryRefs": [
"text"
],
"customAttributes": {},
"imageUrl": "text",
"legal": {
"hsCode": "text"
},
"measurementUnitKey": "liter",
"outOfStockBehaviour": "NONE",
"outOfStockBehaviourByContexts": [
{
"context": [
{
"operator": "NOT",
"type": "FACILITY_GROUP",
"values": [
"uuid-bkrs-0157"
]
}
],
"outOfStockBehaviour": "NONE",
"outOfStockConfig": {
"preorder": {
"availabilityTimeframe": {
"start": "2020-02-03T08:45:50.525Z"
}
},
"restock": {
"restockableInDays": 1
}
},
"priority": 100
}
],
"outOfStockConfig": {
"preorder": {
"availabilityTimeframe": {
"start": "2020-02-03T08:45:50.525Z"
}
},
"restock": {
"restockableInDays": 1
}
},
"recordableAttributes": [
{
"keyLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"key": "Serialnumber",
"recordingRule": "MANDATORY",
"value": "Germany"
}
],
"scannableCodes": [
"text"
],
"scanningRule": {
"values": [
{
"priority": 1,
"scanningRuleType": "ARTICLE"
}
]
},
"stockAvailableUntil": {
"calculationBase": "EXPIRY",
"modifier": "-P30D"
},
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"defaultValue": "text",
"inputType": "DATE",
"required": true
}
},
"tenantArticleId": "4711",
"title": "Adidas Superstar",
"tags": [],
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42,
"facilityId": "4711",
"id": "fsfdsf87fsd",
"status": "ACTIVE"
}
],
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1
}Search for Shipment
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ShipmentSearchPayload
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
ShipmentPaginatedResult
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/shipments/search
POST /api/shipments/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5839
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"anonymized": {
"eq": true,
"notEq": true
},
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"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",
"or": "[Circular Reference]",
"parcels": {
"contains": {
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"status": {
"eq": "INITIAL",
"in": [
"INITIAL"
],
"notEq": "INITIAL"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"anonymized": {
"eq": true,
"notEq": true
},
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"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",
"or": [
{
"and": "[Circular Reference]",
"anonymized": {
"eq": true,
"notEq": true
},
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"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",
"or": "[Circular Reference]",
"parcels": {
"contains": {
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"status": {
"eq": "INITIAL",
"in": [
"INITIAL"
],
"notEq": "INITIAL"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"parcels": {
"contains": {
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"status": {
"eq": "INITIAL",
"in": [
"INITIAL"
],
"notEq": "INITIAL"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"anonymized": {
"eq": true,
"notEq": true
},
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"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",
"or": [
{
"and": [
{
"and": "[Circular Reference]",
"anonymized": {
"eq": true,
"notEq": true
},
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"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",
"or": "[Circular Reference]",
"parcels": {
"contains": {
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"status": {
"eq": "INITIAL",
"in": [
"INITIAL"
],
"notEq": "INITIAL"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"anonymized": {
"eq": true,
"notEq": true
},
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"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",
"or": [
{
"and": "[Circular Reference]",
"anonymized": {
"eq": true,
"notEq": true
},
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"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",
"or": "[Circular Reference]",
"parcels": {
"contains": {
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"status": {
"eq": "INITIAL",
"in": [
"INITIAL"
],
"notEq": "INITIAL"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"parcels": {
"contains": {
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"status": {
"eq": "INITIAL",
"in": [
"INITIAL"
],
"notEq": "INITIAL"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"parcels": {
"contains": {
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"status": {
"eq": "INITIAL",
"in": [
"INITIAL"
],
"notEq": "INITIAL"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
},
"size": 10,
"sort": [
{
"created": "ASC",
"targetTime": "ASC"
}
]
}{
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"shipments": [
{
"carrierLogoUrl": "text",
"carrierProduct": "EXPRESS",
"carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
"carrierServices": [
"SIGNATURE"
],
"customAttributes": {},
"facilityRef": "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."
},
"lineItems": [
{
"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"
}
]
},
"customAttributes": {},
"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"
],
"tags": [],
"id": "climk4dcQFiPdA5ULuhS"
}
],
"operativeProcessRef": "text",
"orderDate": "2026-01-01T00:00:00.000Z",
"paymentInformation": {
"currency": "EUR"
},
"pickJobRef": "Esb20gpHBL94X5NdMp3C",
"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."
},
"processId": "text",
"shortId": "text",
"sourceAddress": {
"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.",
"companyName": "Speedy Boxales Ltd.",
"emailAddresses": [
{
"recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
"value": "text"
}
],
"resolvedCoordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"resolvedTimeZone": {
"offsetInSeconds": 28800,
"source": "Google Maps API",
"timeZoneId": "America/Los_Angeles",
"timeZoneName": "Pacific Standard Time"
}
},
"targetAddress": {
"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."
},
"targetTime": "2020-02-03T09:45:51.525Z",
"targetTimeBaseDate": "2020-02-03T08:45:50.525Z",
"tenantOrderId": "text",
"transfers": [
{
"id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
"type": "RECEIVER"
}
],
"tags": [],
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42,
"anonymized": false,
"carrierKey": "DPD",
"hasActiveCarrier": false,
"id": "95EWrieX09OmeriXIUbb",
"parcels": [
{
"carrierRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
"carrierTrackingNumber": "84168117830018",
"parcelRef": "15EZrieW09OmeriXIUbc",
"status": "OPEN"
}
],
"status": "INITIAL",
"workflowInformation": {
"instanceRef": "64c13ab08edf48a008793cac",
"isAvailable": true,
"nodeRef": "text"
}
}
],
"total": 1
}Search for PackJob
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
PackJobSearchPayload
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
PackJobPaginatedResult
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/packjobs/search
POST /api/packjobs/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 7813
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoice": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"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"
},
"lineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"or": "[Circular Reference]",
"orderDate": "2026-06-17T12:00:00.000Z",
"packingSourceContainers": {
"contains": {
"codes": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"recipient": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"shortId": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoice": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"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"
},
"lineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"or": [
{
"and": "[Circular Reference]",
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoice": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"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"
},
"lineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"or": "[Circular Reference]",
"orderDate": "2026-06-17T12:00:00.000Z",
"packingSourceContainers": {
"contains": {
"codes": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"recipient": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"shortId": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"orderDate": "2026-06-17T12:00:00.000Z",
"packingSourceContainers": {
"contains": {
"codes": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"recipient": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"shortId": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoice": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"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"
},
"lineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"or": [
{
"and": "[Circular Reference]",
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoice": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"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"
},
"lineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"or": "[Circular Reference]",
"orderDate": "2026-06-17T12:00:00.000Z",
"packingSourceContainers": {
"contains": {
"codes": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"recipient": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"shortId": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"orderDate": "2026-06-17T12:00:00.000Z",
"packingSourceContainers": {
"contains": {
"codes": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"recipient": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"shortId": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
},
"size": 10,
"sort": [
{
"lastModified": "ASC",
"orderDate": "ASC",
"targetTime": "ASC"
}
]
}{
"packJobs": [
{
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42,
"anonymized": false,
"assignedUsers": [
{
"userId": "text",
"username": "text"
}
],
"customAttributes": {},
"deliveryChannel": "COLLECT",
"documentHandling": {
"sendLabel": {
"enabled": false
}
},
"documentsRef": "text",
"editor": {
"userId": "text",
"username": "text"
},
"facilityRef": "Esb50gpH7794X5NdMp3C",
"id": "Esb20gpHBL94X5NdMp3C",
"invoice": {
"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."
},
"lineItems": [
{
"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"
}
]
},
"customAttributes": {},
"globalLineItemId": "text",
"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": "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"
},
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
"packed": 20,
"stickers": [],
"tags": []
}
],
"operativeProcessRef": "text",
"orderDate": "2020-02-03T09:45:51.525Z",
"orderRef": "text",
"packingSourceContainers": [
{
"codes": [
"text"
],
"id": "c7467ba8-c28a-4473-8748-a4e54e675e4c",
"previousModuleContainerInfo": {
"containerRef": "019df7f0-0507-7002-a9ef-6285caa2e785",
"type": "LOAD_UNIT"
}
}
],
"pickJobRef": "Pic50gpH7794X5NdMp3C",
"processId": "text",
"recipient": {
"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."
},
"recipientName": "text",
"shortId": "text",
"status": "OPEN",
"stickers": [],
"targetTime": "2020-02-03T09:45:51.525Z",
"tenantOrderId": "text",
"transfers": [
{
"id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
"type": "RECEIVER"
}
],
"workflowInformation": {
"instanceRef": "64c13ab08edf48a008793cac",
"isAvailable": true,
"nodeRef": "text"
},
"tags": []
}
],
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1
}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": [],
"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
}This part of the API is in Beta status. For details, see the API release lifecycle documentation. Search for StowJob
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
StowJobSearchPayload
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
StowJobPaginatedResult
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/stowjobs/search
POST /api/stowjobs/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6079
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"created": {
"after": "-P1W"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"priority": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"shortId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"stowLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID"
},
"heldStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowTo": {
"contains": {
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowed": {
"stowedStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowedStorageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"type": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"takeFrom": {
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"taken": {
"takenStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"type": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"targetTime": "2026-06-17T12:00:00.000Z"
}
],
"created": {
"after": "-P1W"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": [
{
"and": "[Circular Reference]",
"created": {
"after": "-P1W"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"priority": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"shortId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"stowLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID"
},
"heldStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowTo": {
"contains": {
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowed": {
"stowedStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowedStorageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"type": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"takeFrom": {
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"taken": {
"takenStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"type": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"targetTime": "2026-06-17T12:00:00.000Z"
}
],
"priority": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"shortId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"stowLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID"
},
"heldStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowTo": {
"contains": {
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowed": {
"stowedStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowedStorageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"type": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"takeFrom": {
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"taken": {
"takenStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"type": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"targetTime": "2026-06-17T12:00:00.000Z"
}
],
"created": {
"after": "-P1W"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": [
{
"and": "[Circular Reference]",
"created": {
"after": "-P1W"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"priority": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"shortId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"stowLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID"
},
"heldStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowTo": {
"contains": {
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowed": {
"stowedStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowedStorageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"type": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"takeFrom": {
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"taken": {
"takenStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"type": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"targetTime": "2026-06-17T12:00:00.000Z"
}
],
"priority": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
},
"shortId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"stowLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID"
},
"heldStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowTo": {
"contains": {
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowed": {
"stowedStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowedStorageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"type": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"takeFrom": {
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"taken": {
"takenStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"type": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
},
"targetTime": "2026-06-17T12:00:00.000Z"
},
"size": 10,
"sort": [
{
"created": "ASC",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lastModified": "ASC",
"targetTime": "ASC"
}
]
}{
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"stowJobs": [
{
"assignedUsers": [
{
"userId": "text",
"username": "text"
}
],
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"lastModified": "2026-01-01T00:00:00.000Z",
"priority": 1,
"shortId": "text",
"status": "OPEN",
"stowLineItems": [
{
"article": {
"titleLocalized": {},
"customAttributes": {},
"imageUrl": "https://example.com/resource",
"measurementUnitKey": "text",
"scannableCodes": [
"text"
],
"tenantArticleId": "MY_ARTICLE_ID",
"title": "text"
},
"customAttributes": {},
"heldStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"reasons": [
{
"reasonLocalized": {},
"tenantReasonId": "MY_REASON_ID"
}
],
"stowTo": [
{
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"quantity": 1,
"scannableCodes": [
"text"
],
"stockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowed": {
"stowedAt": "2026-06-17T12:00:00.000Z",
"stowedQuantity": 1,
"stowedStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"stowedStorageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"type": "STOCK"
}
],
"takeFrom": {
"quantity": 1,
"scannableCodes": [
"text"
],
"stockInformation": {
"properties": {
"expiry": "text"
},
"traitConfig": [
{
"enabled": true,
"trait": "text"
}
]
},
"stockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"taken": {
"takenAt": "2026-06-17T12:00:00.000Z",
"takenQuantity": 1,
"takenStockRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"type": "STOCK"
}
}
],
"targetTime": "2026-06-17T12:00:00.000Z",
"version": 1
}
],
"total": 1
}This part of the API is in Beta status. For details, see the API release lifecycle documentation. Search for Category
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
CategorySearchPayload
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
CategoryPaginatedResult
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/categories/search
POST /api/categories/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2139
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"nameLocalized": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"and": [
{
"nameLocalized": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"and": [
{
"nameLocalized": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"and": "[Circular Reference]",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"tenantCategoryId": "MY_CATEGORY_ID"
}
],
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"nameLocalized": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"and": "[Circular Reference]",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"tenantCategoryId": "MY_CATEGORY_ID"
}
],
"tenantCategoryId": "MY_CATEGORY_ID"
}
],
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"nameLocalized": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"and": "[Circular Reference]",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"tenantCategoryId": "MY_CATEGORY_ID"
}
],
"tenantCategoryId": "MY_CATEGORY_ID"
},
"size": 10,
"sort": [
{
"created": "ASC",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "ASC",
"lastModified": "ASC",
"name": "ASC",
"tenantCategoryId": "ASC"
}
]
}{
"categories": [
{
"nameLocalized": {},
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"id": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"tenantCategoryId": "MY_CATEGORY_ID",
"version": 1
}
],
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1
}This part of the API is in Beta status. For details, see the API release lifecycle documentation. Search for Facility
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
FacilitySearchPayload
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
FacilityPaginatedResult
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/facilities/search
POST /api/facilities/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 7903
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"address": {
"city": "Yellowstone",
"companyName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"country": "US",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"emailAddresses": "phil.bison@fulfillmenttools.com",
"houseNumber": 42,
"postalCode": "42420",
"province": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"street": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"and": [
{
"address": {
"city": "Yellowstone",
"companyName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"country": "US",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"emailAddresses": "phil.bison@fulfillmenttools.com",
"houseNumber": 42,
"postalCode": "42420",
"province": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"street": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"and": [
{
"address": {
"city": "Yellowstone",
"companyName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"country": "US",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"emailAddresses": "phil.bison@fulfillmenttools.com",
"houseNumber": 42,
"postalCode": "42420",
"province": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"street": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"and": "[Circular Reference]",
"contact": {
"firstName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityGroupIds": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"locationType": {
"eq": "STORE",
"in": [
"STORE"
],
"notEq": "STORE"
},
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"referenced": {
"facilityCarrierConnection": {
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"services": {
"contains": {
"type": {
"eq": "SHIP_FROM_STORE",
"in": [
"SHIP_FROM_STORE"
],
"notEq": "SHIP_FROM_STORE"
}
},
"exists": true
},
"status": {
"eq": "ONLINE",
"in": [
"ONLINE"
],
"notEq": "ONLINE"
},
"tenantFacilityId": "MY_FACILITY_ID",
"type": {
"eq": "MANAGED_FACILITY",
"in": [
"MANAGED_FACILITY"
],
"notEq": "MANAGED_FACILITY"
},
"tags": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"value": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"contact": {
"firstName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityGroupIds": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"locationType": {
"eq": "STORE",
"in": [
"STORE"
],
"notEq": "STORE"
},
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"address": {
"city": "Yellowstone",
"companyName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"country": "US",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"emailAddresses": "phil.bison@fulfillmenttools.com",
"houseNumber": 42,
"postalCode": "42420",
"province": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"street": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"and": "[Circular Reference]",
"contact": {
"firstName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityGroupIds": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"locationType": {
"eq": "STORE",
"in": [
"STORE"
],
"notEq": "STORE"
},
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"referenced": {
"facilityCarrierConnection": {
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"services": {
"contains": {
"type": {
"eq": "SHIP_FROM_STORE",
"in": [
"SHIP_FROM_STORE"
],
"notEq": "SHIP_FROM_STORE"
}
},
"exists": true
},
"status": {
"eq": "ONLINE",
"in": [
"ONLINE"
],
"notEq": "ONLINE"
},
"tenantFacilityId": "MY_FACILITY_ID",
"type": {
"eq": "MANAGED_FACILITY",
"in": [
"MANAGED_FACILITY"
],
"notEq": "MANAGED_FACILITY"
},
"tags": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"value": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"referenced": {
"facilityCarrierConnection": {
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"services": {
"contains": {
"type": {
"eq": "SHIP_FROM_STORE",
"in": [
"SHIP_FROM_STORE"
],
"notEq": "SHIP_FROM_STORE"
}
},
"exists": true
},
"status": {
"eq": "ONLINE",
"in": [
"ONLINE"
],
"notEq": "ONLINE"
},
"tenantFacilityId": "MY_FACILITY_ID",
"type": {
"eq": "MANAGED_FACILITY",
"in": [
"MANAGED_FACILITY"
],
"notEq": "MANAGED_FACILITY"
},
"tags": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"value": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"contact": {
"firstName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityGroupIds": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"locationType": {
"eq": "STORE",
"in": [
"STORE"
],
"notEq": "STORE"
},
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"address": {
"city": "Yellowstone",
"companyName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"country": "US",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"emailAddresses": "phil.bison@fulfillmenttools.com",
"houseNumber": 42,
"postalCode": "42420",
"province": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"street": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"and": "[Circular Reference]",
"contact": {
"firstName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityGroupIds": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"locationType": {
"eq": "STORE",
"in": [
"STORE"
],
"notEq": "STORE"
},
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"referenced": {
"facilityCarrierConnection": {
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"services": {
"contains": {
"type": {
"eq": "SHIP_FROM_STORE",
"in": [
"SHIP_FROM_STORE"
],
"notEq": "SHIP_FROM_STORE"
}
},
"exists": true
},
"status": {
"eq": "ONLINE",
"in": [
"ONLINE"
],
"notEq": "ONLINE"
},
"tenantFacilityId": "MY_FACILITY_ID",
"type": {
"eq": "MANAGED_FACILITY",
"in": [
"MANAGED_FACILITY"
],
"notEq": "MANAGED_FACILITY"
},
"tags": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"value": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"referenced": {
"facilityCarrierConnection": {
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"services": {
"contains": {
"type": {
"eq": "SHIP_FROM_STORE",
"in": [
"SHIP_FROM_STORE"
],
"notEq": "SHIP_FROM_STORE"
}
},
"exists": true
},
"status": {
"eq": "ONLINE",
"in": [
"ONLINE"
],
"notEq": "ONLINE"
},
"tenantFacilityId": "MY_FACILITY_ID",
"type": {
"eq": "MANAGED_FACILITY",
"in": [
"MANAGED_FACILITY"
],
"notEq": "MANAGED_FACILITY"
},
"tags": {
"contains": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"value": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
},
"size": 10,
"sort": [
{
"address": {
"city": "ASC",
"country": "ASC",
"postalCode": "ASC"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"id": "ASC",
"lastModified": "ASC",
"locationType": "ASC",
"name": "ASC",
"services": {
"type": "ASC"
},
"status": "ASC",
"tenantFacilityId": "ASC",
"type": "ASC"
}
]
}{
"facilities": [
{
"address": {
"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.",
"companyName": "Speedy Boxales Ltd.",
"emailAddresses": [
{
"recipient": "'Mailinglist reaching all the employees', 'Marc Fulton, Manager', etc.",
"value": "text"
}
],
"resolvedCoordinates": {
"lat": 50.937531,
"lon": 6.960279
},
"resolvedTimeZone": "America/Los_Angeles"
},
"configs": [
{
"ref": "text",
"rel": "text"
}
],
"id": "Esb20gpHBL94X5NdMp3C",
"operativeCosts": [
{
"currency": "EUR",
"decimalPlaces": 2,
"value": 25000
}
],
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42,
"customAttributes": {},
"name": "Hamburg NW2",
"status": "ONLINE",
"tenantFacilityId": "K12345",
"type": "MANAGED_FACILITY",
"tags": [],
"capacityEnabled": false,
"capacityPlanningTimeframe": 1,
"closingDays": [
{
"date": "2020-02-03T09:45:51.525Z",
"reason": "text",
"recurrence": "YEARLY"
}
],
"contact": {
"customAttributes": {},
"firstName": "text",
"lastName": "text",
"roleDescription": "Manager, Supervisor, Teamleader, etc."
},
"fulfillmentProcessBuffer": "240",
"locationType": "STORE",
"pickingMethods": [
"SINGLE_ORDER"
],
"pickingTimes": {
"friday": [
{
"capacity": 1,
"end": {
"hour": 1,
"minute": 1
},
"start": {
"hour": 1,
"minute": 1
}
}
],
"monday": [
{
"capacity": 1,
"end": {
"hour": 1,
"minute": 1
},
"start": {
"hour": 1,
"minute": 1
}
}
],
"saturday": [
{
"capacity": 1,
"end": {
"hour": 1,
"minute": 1
},
"start": {
"hour": 1,
"minute": 1
}
}
],
"sunday": [
{
"capacity": 1,
"end": {
"hour": 1,
"minute": 1
},
"start": {
"hour": 1,
"minute": 1
}
}
],
"thursday": [
{
"capacity": 1,
"end": {
"hour": 1,
"minute": 1
},
"start": {
"hour": 1,
"minute": 1
}
}
],
"tuesday": [
{
"capacity": 1,
"end": {
"hour": 1,
"minute": 1
},
"start": {
"hour": 1,
"minute": 1
}
}
],
"wednesday": [
{
"capacity": 1,
"end": {
"hour": 1,
"minute": 1
},
"start": {
"hour": 1,
"minute": 1
}
}
]
},
"scanningRule": {
"values": [
{
"priority": 1,
"scanningRuleType": "ARTICLE"
}
]
},
"services": [
{
"type": "SHIP_FROM_STORE"
}
]
}
],
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1
}This part of the API is in Beta status. For details, see the API release lifecycle documentation. Search for Reservation
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
ReservationSearchPayload
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
ReservationPaginatedResult
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/reservations/search
POST /api/reservations/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1472
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"relatedRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": [
{
"and": "[Circular Reference]",
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"relatedRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"relatedRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": [
{
"and": "[Circular Reference]",
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"relatedRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"relatedRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"tenantArticleId": "MY_ARTICLE_ID"
},
"size": 10,
"sort": [
{
"created": "ASC",
"lastModified": "ASC"
}
]
}{
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"reservations": [
{
"created": "2020-02-03T08:45:51.525Z",
"customAttributes": {},
"facilityRef": "text",
"host": {
"reference": "text",
"type": "STOCK"
},
"id": "text",
"lastModified": "2020-02-03T09:45:51.525Z",
"quantity": 1,
"relatedRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"tenantArticleId": "text",
"version": 42
}
],
"total": 1
}Search for HandoverJob
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
HandoverJobSearchPayload
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
HandoverJobPaginatedResult
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/handoverjobs/search
POST /api/handoverjobs/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 12039
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"additionalHandoverJobLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"and": [
{
"additionalHandoverJobLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"and": [
{
"additionalHandoverJobLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"and": "[Circular Reference]",
"anonymized": {
"eq": true,
"notEq": true
},
"assignedUsers": {
"contains": {
"userId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"username": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"channel": {
"eq": "DELIVERY",
"in": [
"DELIVERY"
],
"notEq": "DELIVERY"
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"fullIdentifier": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"handoverJobLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"substituteLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
}
},
"exists": true
},
"handoverJobParcelInfo": {
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"carrierTrackingNumber": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoiceAddress": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"or": "[Circular Reference]",
"pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"pickupIdentifier": {
"eq": "text",
"notEq": "text"
},
"recipientAddress": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"shortIdentifier": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"anonymized": {
"eq": true,
"notEq": true
},
"assignedUsers": {
"contains": {
"userId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"username": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"channel": {
"eq": "DELIVERY",
"in": [
"DELIVERY"
],
"notEq": "DELIVERY"
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"fullIdentifier": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"handoverJobLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"substituteLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
}
},
"exists": true
},
"handoverJobParcelInfo": {
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"carrierTrackingNumber": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoiceAddress": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"or": [
{
"additionalHandoverJobLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"and": "[Circular Reference]",
"anonymized": {
"eq": true,
"notEq": true
},
"assignedUsers": {
"contains": {
"userId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"username": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"channel": {
"eq": "DELIVERY",
"in": [
"DELIVERY"
],
"notEq": "DELIVERY"
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"fullIdentifier": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"handoverJobLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"substituteLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
}
},
"exists": true
},
"handoverJobParcelInfo": {
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"carrierTrackingNumber": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoiceAddress": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"or": "[Circular Reference]",
"pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"pickupIdentifier": {
"eq": "text",
"notEq": "text"
},
"recipientAddress": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"shortIdentifier": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"pickupIdentifier": {
"eq": "text",
"notEq": "text"
},
"recipientAddress": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"shortIdentifier": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"anonymized": {
"eq": true,
"notEq": true
},
"assignedUsers": {
"contains": {
"userId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"username": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"channel": {
"eq": "DELIVERY",
"in": [
"DELIVERY"
],
"notEq": "DELIVERY"
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"fullIdentifier": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"handoverJobLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"substituteLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
}
},
"exists": true
},
"handoverJobParcelInfo": {
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"carrierTrackingNumber": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoiceAddress": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"or": [
{
"additionalHandoverJobLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
}
},
"exists": true
},
"and": "[Circular Reference]",
"anonymized": {
"eq": true,
"notEq": true
},
"assignedUsers": {
"contains": {
"userId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"username": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
},
"channel": {
"eq": "DELIVERY",
"in": [
"DELIVERY"
],
"notEq": "DELIVERY"
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"fullIdentifier": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"handoverJobLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"substituteLineItems": {
"contains": {
"article": {
"tenantArticleId": "MY_ARTICLE_ID",
"title": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
}
},
"exists": true
}
},
"exists": true
},
"handoverJobParcelInfo": {
"carrierKey": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"carrierRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"carrierTrackingNumber": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"shipmentRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoiceAddress": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"or": "[Circular Reference]",
"pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"pickupIdentifier": {
"eq": "text",
"notEq": "text"
},
"recipientAddress": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"shortIdentifier": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
}
],
"pickJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"pickupIdentifier": {
"eq": "text",
"notEq": "text"
},
"recipientAddress": {
"companyName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"email": "phil.bison@fulfillmenttools.com",
"firstName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"lastName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
}
},
"shortIdentifier": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID"
},
"size": 10,
"sort": [
{
"targetTime": "ASC"
}
]
}{
"handoverJobs": [
{
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z",
"version": 42,
"additionalHandoverJobLineItems": [
{
"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",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"measurementUnitKey": "pcs",
"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": 42
}
],
"anonymized": false,
"assignedUsers": [
{
"userId": "text",
"username": "text"
}
],
"cancelReason": "CONSUMER_NO_SHOW",
"channel": "DELIVERY",
"customAttributes": {},
"documents": [
{
"customAttributes": {},
"documentCategory": "EXTERNAL",
"documentType": "PDF",
"id": "text",
"name": "text",
"operations": [
"PRINT"
],
"path": "text",
"priority": 1,
"status": "AVAILABLE"
}
],
"documentsRef": "text",
"expectedHandoverJobLineItems": [
{
"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"
}
]
},
"customAttributes": {},
"quantity": 21,
"scannableCodes": [
"text"
],
"stickers": [],
"transferId": "text",
"tags": []
}
],
"facilityRef": "Esb20gpHBL94X5NdMp3C",
"fullIdentifier": "text",
"handoverJobLineItems": [
{
"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",
"id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
"measurementUnitKey": "pcs",
"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": 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"
},
"serviceJobRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
]
}
],
"handoverJobParcelInfo": {
"carrierLogoUrl": "https://www.example.com/carrierlogo.png",
"carrierParcelRef": "84168117830018",
"carrierRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
"carrierTrackingNumber": "84168117830018",
"parcelRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
"shipmentRef": "9ddb3c80-30ec-42c3-a750-9612296402ca",
"carrierKey": "DHL"
},
"id": "95EWrieX09OmeriXIUbb",
"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."
},
"missingHandoverJobLineItems": [
{
"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"
}
]
},
"customAttributes": {},
"quantity": 1,
"scannableCodes": [
"text"
],
"stickers": [],
"tags": []
}
],
"operativeProcessRef": "text",
"orderDate": "2020-02-03T08:45:50.525Z",
"paid": false,
"pickJobRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
"pickupIdentifier": "H7K29XQRM4",
"pickupServices": [],
"pricing": {
"discounts": [
{
"nameLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"code": "text",
"context": "text",
"name": "text",
"percentage": 1,
"tenantDiscountId": "text",
"type": "ABSOLUTE",
"value": {
"currency": "EUR",
"decimalPlaces": 2,
"value": 1299
}
}
],
"fees": [
{
"name": "text",
"value": {
"currency": "EUR",
"decimalPlaces": 2,
"value": 1299
}
}
],
"taxes": [
{
"ratePercent": 1,
"scope": "text",
"taxableValue": {
"currency": "EUR",
"decimalPlaces": 2,
"value": 1299
},
"type": "text",
"value": {
"currency": "EUR",
"decimalPlaces": 2,
"value": 1299
}
}
],
"total": {
"priceBreakdown": {
"subTotal": {
"currency": "EUR",
"decimalPlaces": 2,
"value": 1299
},
"total": {
"currency": "EUR",
"decimalPlaces": 2,
"value": 1299
},
"totalDiscounts": {
"breakdown": {
"lineItemDiscounts": {
"currency": "EUR",
"decimalPlaces": 2,
"value": 1299
},
"orderDiscounts": {
"currency": "EUR",
"decimalPlaces": 2,
"value": 1299
}
},
"value": {
"currency": "EUR",
"decimalPlaces": 2,
"value": 1299
}
},
"totalFees": {
"currency": "EUR",
"decimalPlaces": 2,
"value": 1299
},
"totalLineItemSurcharges": {
"currency": "EUR",
"decimalPlaces": 2,
"value": 1299
},
"totalTaxes": {
"currency": "EUR",
"decimalPlaces": 2,
"value": 1299
}
}
}
},
"processId": "text",
"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."
},
"scannableCodes": [
"text"
],
"shortIdentifier": "text",
"status": "OPEN",
"stickers": [],
"targetTime": "2026-01-01T00:00:00.000Z",
"tenantOrderId": "R456728546",
"transfers": [
{
"id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
"type": "RECEIVER"
}
],
"workflowInformation": {
"instanceRef": "64c13ab08edf48a008793cac",
"isAvailable": true,
"nodeRef": "text"
},
"tags": []
}
],
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1
}Search for FacilityGroup
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
FacilityGroupSearchPayload
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
FacilityGroupPaginatedResult
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/facilitygroups/search
POST /api/facilitygroups/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1705
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"facilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"tenantFacilityGroupId": "MY_FACILITYGROUP_ID"
}
],
"facilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"and": "[Circular Reference]",
"facilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"tenantFacilityGroupId": "MY_FACILITYGROUP_ID"
}
],
"tenantFacilityGroupId": "MY_FACILITYGROUP_ID"
}
],
"facilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"and": "[Circular Reference]",
"facilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"tenantFacilityGroupId": "MY_FACILITYGROUP_ID"
}
],
"tenantFacilityGroupId": "MY_FACILITYGROUP_ID"
},
"size": 10,
"sort": [
{
"facilityCount": "ASC",
"name": "ASC",
"tenantFacilityGroupId": "ASC"
}
]
}{
"facilityGroups": [
{
"nameLocalized": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"facilityCount": 1,
"facilityRefs": [
"0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"0190d6e8-9a1b-7c2d-8e3f-5a7b9c1d3e5f"
],
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"lastModified": "2026-01-01T00:00:00.000Z",
"name": "text",
"tenantFacilityGroupId": "K12345",
"version": 1
}
],
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1
}Search for InboundProcess
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
InboundProcessSearchPayload
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
InboundProcessPaginatedResult
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/inboundprocesses/search
POST /api/inboundprocesses/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 7830
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"inboundDate": "2026-06-17T12:00:00.000Z",
"or": "[Circular Reference]",
"purchaseOrder": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"supplier": {
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"transfer": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
},
"receipts": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": {
"contains": {
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantInboundProcessId": "MY_INBOUNDPROCESS_ID"
}
],
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"inboundDate": "2026-06-17T12:00:00.000Z",
"or": [
{
"and": "[Circular Reference]",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"inboundDate": "2026-06-17T12:00:00.000Z",
"or": "[Circular Reference]",
"purchaseOrder": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"supplier": {
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"transfer": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
},
"receipts": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": {
"contains": {
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantInboundProcessId": "MY_INBOUNDPROCESS_ID"
}
],
"purchaseOrder": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"supplier": {
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"transfer": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
},
"receipts": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": {
"contains": {
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantInboundProcessId": "MY_INBOUNDPROCESS_ID"
}
],
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"inboundDate": "2026-06-17T12:00:00.000Z",
"or": [
{
"and": "[Circular Reference]",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"inboundDate": "2026-06-17T12:00:00.000Z",
"or": "[Circular Reference]",
"purchaseOrder": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"supplier": {
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"transfer": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
},
"receipts": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": {
"contains": {
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantInboundProcessId": "MY_INBOUNDPROCESS_ID"
}
],
"purchaseOrder": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"supplier": {
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"transfer": {
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
},
"receipts": {
"contains": {
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": {
"contains": {
"stockProperties": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"tenantArticleId": "MY_ARTICLE_ID"
},
"exists": true
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
}
},
"exists": true
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"status": {
"eq": "OPEN",
"in": [
"OPEN"
],
"notEq": "OPEN"
},
"tenantInboundProcessId": "MY_INBOUNDPROCESS_ID"
},
"size": 10,
"sort": [
{
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lastModified": "ASC",
"po_created": "ASC",
"purchaseOrder": {
"requestedDate": "2026-06-17T12:00:00.000Z",
"supplier": {
"name": "ASC"
}
}
}
]
}{
"inboundProcesses": [
{
"anonymized": true,
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"facilityRef": "text",
"id": "text",
"inboundDate": "2026-06-17T12:00:00.000Z",
"lastModified": "2026-01-01T00:00:00.000Z",
"onHold": true,
"origin": [
{
"name": "text"
}
],
"purchaseOrder": {
"created": "2026-01-01T00:00:00.000Z",
"customAttributes": {},
"id": "text",
"lastModified": "2026-01-01T00:00:00.000Z",
"orderDate": "2026-06-17T12:00:00.000Z",
"requestedDate": "2026-06-17T12:00:00.000Z",
"requestedItems": [
{
"customAttributes": {},
"quantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"tenantArticleId": "text"
}
],
"status": "OPEN",
"supplier": {
"name": "text"
},
"transfer": {
"id": "text"
}
},
"receipts": [
{
"asnRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"receivedDate": "2026-06-17T12:00:00.000Z",
"receivedItems": [
{
"acceptedQuantity": {
"unit": "text",
"value": 42
},
"comments": [
{
"content": "text",
"documentSetRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "text",
"userRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"customAttributes": {},
"id": "text",
"rejectedQuantity": {
"unit": "text",
"value": 42
},
"stockProperties": {
"expiry": "text"
},
"storageLocationRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantArticleId": "MY_ARTICLE_ID"
}
],
"status": "OPEN"
}
],
"scannableCodes": [
"text"
],
"status": "OPEN",
"tenantInboundProcessId": "text",
"version": 1
}
],
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1
}Search for StorageLocation
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
StorageLocationSearchPayload
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
StorageLocationPaginatedResult
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/storagelocations/search
POST /api/storagelocations/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5074
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"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"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"referenced": {
"stock": {
"hasStocks": {
"eq": true,
"notEq": true
},
"sumOfValues": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
}
}
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantLocationId": "MY_LOCATION_ID",
"traits": {
"contains": {
"eq": "PICKABLE",
"in": [
"PICKABLE"
],
"notEq": "PICKABLE"
}
},
"type": {
"eq": "SINGLE_STORAGE",
"in": [
"SINGLE_STORAGE"
],
"notEq": "SINGLE_STORAGE"
},
"zoneRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"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"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"and": "[Circular Reference]",
"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"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"referenced": {
"stock": {
"hasStocks": {
"eq": true,
"notEq": true
},
"sumOfValues": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
}
}
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantLocationId": "MY_LOCATION_ID",
"traits": {
"contains": {
"eq": "PICKABLE",
"in": [
"PICKABLE"
],
"notEq": "PICKABLE"
}
},
"type": {
"eq": "SINGLE_STORAGE",
"in": [
"SINGLE_STORAGE"
],
"notEq": "SINGLE_STORAGE"
},
"zoneRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"referenced": {
"stock": {
"hasStocks": {
"eq": true,
"notEq": true
},
"sumOfValues": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
}
}
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantLocationId": "MY_LOCATION_ID",
"traits": {
"contains": {
"eq": "PICKABLE",
"in": [
"PICKABLE"
],
"notEq": "PICKABLE"
}
},
"type": {
"eq": "SINGLE_STORAGE",
"in": [
"SINGLE_STORAGE"
],
"notEq": "SINGLE_STORAGE"
},
"zoneRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"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"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": [
{
"and": "[Circular Reference]",
"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"
},
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": {
"eq": true,
"notEq": true
}
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"name": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"or": "[Circular Reference]",
"referenced": {
"stock": {
"hasStocks": {
"eq": true,
"notEq": true
},
"sumOfValues": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
}
}
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantLocationId": "MY_LOCATION_ID",
"traits": {
"contains": {
"eq": "PICKABLE",
"in": [
"PICKABLE"
],
"notEq": "PICKABLE"
}
},
"type": {
"eq": "SINGLE_STORAGE",
"in": [
"SINGLE_STORAGE"
],
"notEq": "SINGLE_STORAGE"
},
"zoneRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
}
],
"referenced": {
"stock": {
"hasStocks": {
"eq": true,
"notEq": true
},
"sumOfValues": {
"eq": 1,
"gt": 1,
"gte": 1,
"in": [
1
],
"lt": 1,
"lte": 1,
"notEq": 1,
"notIn": [
1
]
}
}
},
"scannableCodes": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"tenantLocationId": "MY_LOCATION_ID",
"traits": {
"contains": {
"eq": "PICKABLE",
"in": [
"PICKABLE"
],
"notEq": "PICKABLE"
}
},
"type": {
"eq": "SINGLE_STORAGE",
"in": [
"SINGLE_STORAGE"
],
"notEq": "SINGLE_STORAGE"
},
"zoneRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f"
},
"size": 10,
"sort": [
{
"created": "ASC",
"customAttributes": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"lastModified": "ASC",
"name": "ASC",
"tenantLocationId": "ASC",
"zoneRef": "ASC"
}
]
}{
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"storageLocations": [
{
"version": 42,
"information": "text",
"name": "text",
"runningSequences": [
{
"nextStorageLocationRef": "text",
"previousStorageLocationRef": "text",
"type": "PICKING_SEQUENCE"
}
],
"scannableCodes": [
"text"
],
"tenantLocationId": "text",
"traitConfig": [
{
"enabled": true,
"trait": "PICKABLE"
}
],
"traits": [
"PICKABLE"
],
"type": "SINGLE_STORAGE",
"zoneName": "text",
"zoneRef": "Esb20gpHBL94X5NdMp3C",
"customAttributes": {},
"created": "2020-02-03T08:45:51.525Z",
"lastModified": "2020-02-03T09:45:51.525Z"
}
],
"total": 1
}Search for LinkedServiceJobs
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
LinkedServiceJobsSearchPayload
afterstringOptional
The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.
beforestringOptional
The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).
lastnumber · min: 1 · max: 250Optional
Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.
sizenumber · min: 1 · max: 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
LinkedServiceJobsPaginatedResult
totalnumberOptional
The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this endpoint
application/json
post/api/linkedservicejobs/search
POST /api/linkedservicejobs/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6305
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"additionalInformation": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"and": [
{
"additionalInformation": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"and": [
{
"additionalInformation": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"and": "[Circular Reference]",
"articleTitles": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"channel": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"consumerName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoiceAddress": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"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"
},
"linkedServiceJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"serviceName": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"shippingAddress": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID",
"usersModificationHistory": {
"contains": {
"username": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"articleTitles": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"channel": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"consumerName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoiceAddress": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"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"
},
"linkedServiceJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": [
{
"additionalInformation": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"and": "[Circular Reference]",
"articleTitles": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"channel": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"consumerName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoiceAddress": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"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"
},
"linkedServiceJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"serviceName": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"shippingAddress": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID",
"usersModificationHistory": {
"contains": {
"username": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"serviceName": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"shippingAddress": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID",
"usersModificationHistory": {
"contains": {
"username": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"articleTitles": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"channel": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"consumerName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoiceAddress": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"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"
},
"linkedServiceJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": [
{
"additionalInformation": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"and": "[Circular Reference]",
"articleTitles": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"channel": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"consumerName": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"facilityRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"invoiceAddress": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"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"
},
"linkedServiceJobRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"serviceName": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"shippingAddress": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID",
"usersModificationHistory": {
"contains": {
"username": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"serviceName": {
"contains": {
"eq": "text",
"notEq": "text"
}
},
"shippingAddress": {
"eq": "text",
"in": [
"text"
],
"like": "text",
"notEq": "text",
"notIn": [
"text"
]
},
"status": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"targetTime": "2026-06-17T12:00:00.000Z",
"tenantOrderId": "MY_ORDER_ID",
"usersModificationHistory": {
"contains": {
"username": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
},
"size": 10,
"sort": [
{
"lastModified": "ASC",
"targetTime": "ASC"
}
]
}{
"linkedServiceJobs": [
{
"created": "2020-02-03T08:45:51.525Z",
"facilityRef": "cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05",
"fullIdentifier": "240429_lorem-42",
"id": "9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1",
"includedServiceJobLinkIds": [
"cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"
],
"includedServiceJobRefs": [
"cdb1dfc4-8361-4ba9-b3c2-33a6f2fc8d05"
],
"lastModified": "2020-02-03T09:45:51.525Z",
"operativeProcessRef": "9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1",
"processRef": "9a14e183-ff86-4b6e-a2dc-eb4c7e312ab1",
"serviceJobLinks": [
{
"id": "0ed803c2-fa20-48d9-9c1b-0d243937a9ad",
"nextServiceJobLinks": [
"[Circular Reference]"
],
"previousServiceJobLinkRefs": [
"9f197dbf-c724-469b-90f1-dc94f20b2825"
],
"previousServiceJobRefs": [
"9f197dbf-c724-469b-90f1-dc94f20b2825"
],
"serviceJobRef": "0ed803c2-fa20-48d9-9c1b-0d243937a9ad"
}
],
"status": "OPEN",
"targetTime": "2020-02-03T09:45:51.525Z",
"usersModificationHistory": [
{
"modificationDate": "2026-01-01T00:00:00.000Z",
"userId": "text",
"username": "text"
}
],
"version": 42
}
],
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1
}This part of the API is in Beta status. For details, see the API release lifecycle documentation. Search for LookupRecordItem
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
LookupRecordItemSearchPayload
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
LookupRecordItemPaginatedResult
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/lookuprecorditems/search
POST /api/lookuprecorditems/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1879
{
"after": "text",
"before": "text",
"last": 1,
"options": {
"withTotal": true
},
"query": {
"and": [
{
"and": [
{
"and": "[Circular Reference]",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"recordRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantRecordId": "MY_RECORD_ID",
"values": {
"contains": {
"attributeId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"attributeValue": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": [
{
"and": "[Circular Reference]",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"recordRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantRecordId": "MY_RECORD_ID",
"values": {
"contains": {
"attributeId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"attributeValue": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"recordRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantRecordId": "MY_RECORD_ID",
"values": {
"contains": {
"attributeId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"attributeValue": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": [
{
"and": "[Circular Reference]",
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"or": "[Circular Reference]",
"recordRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantRecordId": "MY_RECORD_ID",
"values": {
"contains": {
"attributeId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"attributeValue": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
}
],
"recordRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantRecordId": "MY_RECORD_ID",
"values": {
"contains": {
"attributeId": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
},
"attributeValue": {
"eq": "text",
"in": [
"text"
],
"notEq": "text",
"notIn": [
"text"
]
}
},
"exists": true
}
},
"size": 10
}{
"lookupRecordItems": [
{
"id": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"recordRef": "0190d6e8-8c3a-7f1b-9d2e-4a6b8c0d1e2f",
"tenantRecordId": "MY_RECORD_ID",
"values": {
"attributeId": "text",
"attributeValue": "text"
}
}
],
"pageInfo": {
"endCursor": "text",
"hasNextPage": true,
"hasPreviousPage": true,
"startCursor": "text"
},
"total": 1
}Last updated
Was this helpful?