Search endpoints

List roles (search)

post

Search for Role

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/roles/search

HTTPcURLJavaScriptPython

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: 1474

{
  "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": 1,
  "sort": [
    {
      "displayName": "ASC"
    }
  ]
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "roles": [
    {
      "contexts": [
        {
          "type": "FACILITY",
          "values": [
            "text"
          ]
        }
      ],
      "created": "2026-03-02T18:33:27.613Z",
      "customAttributes": {},
      "description": "text",
      "displayName": "text",
      "lastModified": "2026-03-02T18:33:27.613Z",
      "name": "text",
      "permissions": [
        "USER_READ"
      ],
      "version": 1
    }
  ],
  "total": 1
}

List users (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/users/search

HTTPcURLJavaScriptPython

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: 6644

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "assignedFacilities": {
              "contains": {
                "facilityRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "assignedRoles": {
              "contains": {
                "context": {
                  "contains": {
                    "type": {
                      "eq": "FACILITY",
                      "in": [
                        "FACILITY"
                      ],
                      "notEq": "FACILITY"
                    },
                    "values": {
                      "contains": {
                        "eq": "text",
                        "notEq": "text"
                      }
                    }
                  }
                },
                "ref": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "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"
                  }
                }
              }
            },
            "facilityLimitations": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              },
              "exists": true
            },
            "firstname": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "lastname": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "username": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "assignedFacilities": {
          "contains": {
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "assignedRoles": {
          "contains": {
            "context": {
              "contains": {
                "type": {
                  "eq": "FACILITY",
                  "in": [
                    "FACILITY"
                  ],
                  "notEq": "FACILITY"
                },
                "values": {
                  "contains": {
                    "eq": "text",
                    "notEq": "text"
                  }
                }
              }
            },
            "ref": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "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"
              }
            }
          }
        },
        "facilityLimitations": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          },
          "exists": true
        },
        "firstname": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "lastname": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "assignedFacilities": {
              "contains": {
                "facilityRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "assignedRoles": {
              "contains": {
                "context": {
                  "contains": {
                    "type": {
                      "eq": "FACILITY",
                      "in": [
                        "FACILITY"
                      ],
                      "notEq": "FACILITY"
                    },
                    "values": {
                      "contains": {
                        "eq": "text",
                        "notEq": "text"
                      }
                    }
                  }
                },
                "ref": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "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"
                  }
                }
              }
            },
            "facilityLimitations": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              },
              "exists": true
            },
            "firstname": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "lastname": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "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": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    },
    "assignedRoles": {
      "contains": {
        "context": {
          "contains": {
            "type": {
              "eq": "FACILITY",
              "in": [
                "FACILITY"
              ],
              "notEq": "FACILITY"
            },
            "values": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            }
          }
        },
        "ref": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    },
    "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"
          }
        }
      }
    },
    "facilityLimitations": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      },
      "exists": true
    },
    "firstname": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "lastModified": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "lastname": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "assignedFacilities": {
          "contains": {
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "assignedRoles": {
          "contains": {
            "context": {
              "contains": {
                "type": {
                  "eq": "FACILITY",
                  "in": [
                    "FACILITY"
                  ],
                  "notEq": "FACILITY"
                },
                "values": {
                  "contains": {
                    "eq": "text",
                    "notEq": "text"
                  }
                }
              }
            },
            "ref": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "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"
              }
            }
          }
        },
        "facilityLimitations": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          },
          "exists": true
        },
        "firstname": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "lastname": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "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": 1,
  "sort": [
    {
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "firstname": "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": "text",
        "type": "EMAIL_PASSWORD"
      },
      "authenticationProviderType": "de_DE",
      "created": "2026-03-02T18:33:27.613Z",
      "email": "[email protected]",
      "facilityLimitations": [
        "text"
      ],
      "firstname": "John",
      "id": "text",
      "lastModified": "2026-03-02T18:33:27.613Z",
      "lastname": "Doe",
      "locale": "de_DE",
      "username": "johndoe",
      "version": 1
    }
  ]
}

List zones (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/zones/search

HTTPcURLJavaScriptPython

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: 1720

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]"
          }
        ],
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]"
          }
        ]
      }
    ],
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "name": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]"
      }
    ]
  },
  "size": 1,
  "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"
    }
  ]
}

List stocks (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/stocks/search

HTTPcURLJavaScriptPython

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: 7487

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "availableUntil": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "conditions": {
              "contains": {
                "eq": "DEFECTIVE",
                "in": [
                  "DEFECTIVE"
                ],
                "notEq": "DEFECTIVE"
              }
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "locationRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "receiptDate": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "scannableCodes": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "tenantArticleId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "tenantFacilityId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "tenantStockId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "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-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "conditions": {
          "contains": {
            "eq": "DEFECTIVE",
            "in": [
              "DEFECTIVE"
            ],
            "notEq": "DEFECTIVE"
          }
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "locationRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "availableUntil": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "conditions": {
              "contains": {
                "eq": "DEFECTIVE",
                "in": [
                  "DEFECTIVE"
                ],
                "notEq": "DEFECTIVE"
              }
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "locationRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "receiptDate": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "scannableCodes": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "tenantArticleId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "tenantFacilityId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "tenantStockId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "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": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "scannableCodes": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "tenantArticleId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "tenantFacilityId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "tenantStockId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "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-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "conditions": {
      "contains": {
        "eq": "DEFECTIVE",
        "in": [
          "DEFECTIVE"
        ],
        "notEq": "DEFECTIVE"
      }
    },
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "locationRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "availableUntil": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "conditions": {
          "contains": {
            "eq": "DEFECTIVE",
            "in": [
              "DEFECTIVE"
            ],
            "notEq": "DEFECTIVE"
          }
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "locationRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "receiptDate": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "scannableCodes": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "tenantArticleId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "tenantFacilityId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "tenantStockId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "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": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "scannableCodes": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "tenantArticleId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "tenantFacilityId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "tenantStockId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "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": 1,
  "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-03-02T18:33:27.613Z",
      "conditions": [
        "DEFECTIVE"
      ],
      "created": "2026-03-02T18:33:27.613Z",
      "customAttributes": {},
      "facility": {
        "facilityRef": "text",
        "tenantFacilityId": "text"
      },
      "facilityRef": "text",
      "id": "text",
      "lastModified": "2026-03-02T18:33:27.613Z",
      "locationRef": "text",
      "properties": {
        "expiry": "text"
      },
      "receiptDate": "2026-03-02T18:33:27.613Z",
      "reserved": 1,
      "scannableCodes": [
        "text"
      ],
      "scores": [
        "text"
      ],
      "serializedProperties": "text",
      "tenantArticleId": "text",
      "tenantStockId": "text",
      "traitConfig": [
        {
          "enabled": true,
          "trait": "text"
        }
      ],
      "traits": [
        "PICKABLE"
      ],
      "value": 1,
      "version": 1
    }
  ],
  "total": 1
}

List parcels (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/parcels/search

HTTPcURLJavaScriptPython

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: 9396

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "carrierRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "invoice": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "or": "[Circular Reference]",
            "recipient": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "firstName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "lastName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "shipmentRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "shortId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            }
          }
        ],
        "carrierRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "invoice": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "carrierRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "invoice": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "lastModified": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "or": "[Circular Reference]",
            "recipient": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "firstName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "lastName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "shipmentRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "shortId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            }
          }
        ],
        "recipient": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "firstName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "lastName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "shipmentRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "shortId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        }
      }
    ],
    "carrierRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "created": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "invoice": {
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "email": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "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": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "title": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      }
    },
    "lastModified": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "carrierRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "invoice": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "lastModified": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "or": "[Circular Reference]",
        "recipient": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "firstName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "lastName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "shipmentRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "shortId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        }
      }
    ],
    "recipient": {
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "email": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "firstName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "lastName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "shipmentRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "shortId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "status": {
      "eq": "OPEN",
      "in": [
        "OPEN"
      ],
      "notEq": "OPEN"
    }
  },
  "size": 1,
  "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,
      "anonymized": false,
      "carrierInformation": {
        "shippingContainerNumber": "123456-ABC"
      },
      "carrierProduct": "EXPRESS",
      "carrierRef": "cf00e102-34f2-45c1-a846-6a21f384321e",
      "customAttributes": {},
      "customProductValue": 12.5,
      "dimensions": {
        "customWeight": 1700,
        "height": 50,
        "length": 100,
        "weight": 1700,
        "width": 25
      },
      "documentsRef": "text",
      "facilityRef": "text",
      "id": "95EWrieX09OmeriXIUbb",
      "invoice": {
        "addressType": "POSTAL_ADDRESS",
        "companyName": "Speedy Boxales Ltd.",
        "coordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "email": "[email protected]",
        "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": {},
          "customAttributes": {},
          "globalLineItemId": "text",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "quantity": 1,
          "recordableAttributes": [
            {
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "group": "general",
              "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "key": "country of origin",
              "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "recordingRule": "MANDATORY",
              "value": "Germany"
            }
          ],
          "scannableCodes": [
            "text"
          ]
        }
      ],
      "loadUnitRefs": [
        "text"
      ],
      "operativeProcessRef": "text",
      "paymentInformation": {
        "currency": "EUR"
      },
      "pickUpInformation": {
        "endTime": "2026-03-02T18:33:27.613Z",
        "startTime": "2026-03-02T18:33:27.613Z"
      },
      "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": "[email protected]",
        "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,
        "identityCheckCompany": true,
        "identityCheckPrivate": 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"
        }
      ]
    }
  ],
  "total": 1
}

List listings (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/listings/search

HTTPcURLJavaScriptPython

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: 7242

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "availabilityTimeframe": {
              "start": {
                "after": "text",
                "before": "text",
                "eq": "2026-03-02T18:33:27.613Z",
                "gt": "2026-03-02T18:33:27.613Z",
                "gte": "2026-03-02T18:33:27.613Z",
                "lt": "2026-03-02T18:33:27.613Z",
                "lte": "2026-03-02T18:33:27.613Z",
                "notEq": "2026-03-02T18:33:27.613Z"
              }
            },
            "categoryRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "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": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "weight": {
              "eq": 1,
              "gt": 1,
              "gte": 1,
              "in": [
                1
              ],
              "lt": 1,
              "lte": 1,
              "notEq": 1,
              "notIn": [
                1
              ]
            },
            "tags": {
              "contains": {
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "value": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "availabilityTimeframe": {
          "start": {
            "after": "text",
            "before": "text",
            "eq": "2026-03-02T18:33:27.613Z",
            "gt": "2026-03-02T18:33:27.613Z",
            "gte": "2026-03-02T18:33:27.613Z",
            "lt": "2026-03-02T18:33:27.613Z",
            "lte": "2026-03-02T18:33:27.613Z",
            "notEq": "2026-03-02T18:33:27.613Z"
          }
        },
        "categoryRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "measurementUnitKey": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "availabilityTimeframe": {
              "start": {
                "after": "text",
                "before": "text",
                "eq": "2026-03-02T18:33:27.613Z",
                "gt": "2026-03-02T18:33:27.613Z",
                "gte": "2026-03-02T18:33:27.613Z",
                "lt": "2026-03-02T18:33:27.613Z",
                "lte": "2026-03-02T18:33:27.613Z",
                "notEq": "2026-03-02T18:33:27.613Z"
              }
            },
            "categoryRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "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": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "weight": {
              "eq": 1,
              "gt": 1,
              "gte": 1,
              "in": [
                1
              ],
              "lt": 1,
              "lte": 1,
              "notEq": 1,
              "notIn": [
                1
              ]
            },
            "tags": {
              "contains": {
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "value": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "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": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "weight": {
          "eq": 1,
          "gt": 1,
          "gte": 1,
          "in": [
            1
          ],
          "lt": 1,
          "lte": 1,
          "notEq": 1,
          "notIn": [
            1
          ]
        },
        "tags": {
          "contains": {
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "value": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "availabilityTimeframe": {
      "start": {
        "after": "text",
        "before": "text",
        "eq": "2026-03-02T18:33:27.613Z",
        "gt": "2026-03-02T18:33:27.613Z",
        "gte": "2026-03-02T18:33:27.613Z",
        "lt": "2026-03-02T18:33:27.613Z",
        "lte": "2026-03-02T18:33:27.613Z",
        "notEq": "2026-03-02T18:33:27.613Z"
      }
    },
    "categoryRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "created": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "measurementUnitKey": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "availabilityTimeframe": {
          "start": {
            "after": "text",
            "before": "text",
            "eq": "2026-03-02T18:33:27.613Z",
            "gt": "2026-03-02T18:33:27.613Z",
            "gte": "2026-03-02T18:33:27.613Z",
            "lt": "2026-03-02T18:33:27.613Z",
            "lte": "2026-03-02T18:33:27.613Z",
            "notEq": "2026-03-02T18:33:27.613Z"
          }
        },
        "categoryRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "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": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "weight": {
          "eq": 1,
          "gt": 1,
          "gte": 1,
          "in": [
            1
          ],
          "lt": 1,
          "lte": 1,
          "notEq": 1,
          "notIn": [
            1
          ]
        },
        "tags": {
          "contains": {
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "value": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "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": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "weight": {
      "eq": 1,
      "gt": 1,
      "gte": 1,
      "in": [
        1
      ],
      "lt": 1,
      "lte": 1,
      "notEq": 1,
      "notIn": [
        1
      ]
    },
    "tags": {
      "contains": {
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "value": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    }
  },
  "size": 1,
  "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"
      ],
      "currency": "EUR",
      "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
        }
      },
      "price": 1200,
      "recordableAttributes": [
        {
          "keyLocalized": {
            "de_DE": "Wert",
            "en_US": "Value",
            "ru_RU": "значение"
          },
          "key": "Serialnumber",
          "recordingRule": "MANDATORY",
          "value": "Germany"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "scanningRule": {
        "values": []
      },
      "stockAvailableUntil": {
        "calculationBase": "EXPIRY",
        "modifier": "-P30D"
      },
      "stockProperties": {
        "ANY_ADDITIONAL_PROPERTY": {
          "defaultValue": "text",
          "inputType": "DATE",
          "required": true
        }
      },
      "tenantArticleId": "4711",
      "title": "Adidas Superstar",
      "weight": 1,
      "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
}

List shipments (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/shipments/search

HTTPcURLJavaScriptPython

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: 8071

{
  "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": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "parcels": {
              "contains": {
                "status": {
                  "eq": "OPEN",
                  "in": [
                    "OPEN"
                  ],
                  "notEq": "OPEN"
                }
              }
            },
            "pickJobRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "INITIAL",
              "in": [
                "INITIAL"
              ],
              "notEq": "INITIAL"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "anonymized": {
          "eq": true,
          "notEq": true
        },
        "carrierKey": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "carrierRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "anonymized": {
              "eq": true,
              "notEq": true
            },
            "carrierKey": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "carrierRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "parcels": {
              "contains": {
                "status": {
                  "eq": "OPEN",
                  "in": [
                    "OPEN"
                  ],
                  "notEq": "OPEN"
                }
              }
            },
            "pickJobRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "INITIAL",
              "in": [
                "INITIAL"
              ],
              "notEq": "INITIAL"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "parcels": {
          "contains": {
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            }
          }
        },
        "pickJobRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "INITIAL",
          "in": [
            "INITIAL"
          ],
          "notEq": "INITIAL"
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "anonymized": {
      "eq": true,
      "notEq": true
    },
    "carrierKey": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "carrierRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "created": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "anonymized": {
              "eq": true,
              "notEq": true
            },
            "carrierKey": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "carrierRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "parcels": {
              "contains": {
                "status": {
                  "eq": "OPEN",
                  "in": [
                    "OPEN"
                  ],
                  "notEq": "OPEN"
                }
              }
            },
            "pickJobRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "INITIAL",
              "in": [
                "INITIAL"
              ],
              "notEq": "INITIAL"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "anonymized": {
          "eq": true,
          "notEq": true
        },
        "carrierKey": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "carrierRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "anonymized": {
              "eq": true,
              "notEq": true
            },
            "carrierKey": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "carrierRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "parcels": {
              "contains": {
                "status": {
                  "eq": "OPEN",
                  "in": [
                    "OPEN"
                  ],
                  "notEq": "OPEN"
                }
              }
            },
            "pickJobRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "status": {
              "eq": "INITIAL",
              "in": [
                "INITIAL"
              ],
              "notEq": "INITIAL"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "parcels": {
          "contains": {
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            }
          }
        },
        "pickJobRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "status": {
          "eq": "INITIAL",
          "in": [
            "INITIAL"
          ],
          "notEq": "INITIAL"
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "parcels": {
      "contains": {
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        }
      }
    },
    "pickJobRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "status": {
      "eq": "INITIAL",
      "in": [
        "INITIAL"
      ],
      "notEq": "INITIAL"
    },
    "targetTime": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "tenantOrderId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "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": "[email protected]",
        "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": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "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-03-02T18:33:27.613Z",
      "paymentInformation": {
        "currency": "EUR"
      },
      "pickJobRef": "Esb20gpHBL94X5NdMp3C",
      "postalAddress": {
        "addressType": "POSTAL_ADDRESS",
        "companyName": "Speedy Boxales Ltd.",
        "coordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "email": "[email protected]",
        "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": "[email protected]",
        "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"
    }
  ],
  "total": 1
}

List pack jobs (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/packjobs/search

HTTPcURLJavaScriptPython

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: 10747

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "facilityRef": {
              "eq": "text",
              "notEq": "text"
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "invoice": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "lineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "or": "[Circular Reference]",
            "orderDate": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "packingSourceContainers": {
              "contains": {
                "codes": {
                  "contains": {
                    "eq": "text",
                    "notEq": "text"
                  }
                }
              }
            },
            "recipient": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "facilityRef": {
          "eq": "text",
          "notEq": "text"
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "invoice": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "lineItems": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "facilityRef": {
              "eq": "text",
              "notEq": "text"
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "invoice": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "lineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "or": "[Circular Reference]",
            "orderDate": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "packingSourceContainers": {
              "contains": {
                "codes": {
                  "contains": {
                    "eq": "text",
                    "notEq": "text"
                  }
                }
              }
            },
            "recipient": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "orderDate": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "packingSourceContainers": {
          "contains": {
            "codes": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            }
          }
        },
        "recipient": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "facilityRef": {
      "eq": "text",
      "notEq": "text"
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "invoice": {
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "email": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "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-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "lineItems": {
      "contains": {
        "article": {
          "tenantArticleId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "title": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      }
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "facilityRef": {
          "eq": "text",
          "notEq": "text"
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "invoice": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "lineItems": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "or": "[Circular Reference]",
        "orderDate": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "packingSourceContainers": {
          "contains": {
            "codes": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            }
          }
        },
        "recipient": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "orderDate": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "packingSourceContainers": {
      "contains": {
        "codes": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        }
      }
    },
    "recipient": {
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "email": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "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": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "tenantOrderId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "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": "[email protected]",
        "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": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "customAttributes": {},
          "globalLineItemId": "text",
          "id": "climk4dcQFiPdA5ULuhS",
          "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"
          ],
          "measurementUnitKey": "liter",
          "originId": "df671041-10dd-4600-a2ff-e9ffe2556bba",
          "packed": 20,
          "serviceJobRefs": [
            "text"
          ],
          "stickers": [],
          "tags": []
        }
      ],
      "operativeProcessRef": "text",
      "orderDate": "2020-02-03T09:45:51.525Z",
      "orderRef": "text",
      "packingSourceContainers": [
        {
          "codes": [
            "text"
          ],
          "id": "c7467ba8-c28a-4473-8748-a4e54e675e4c",
          "loadUnitRef": "2357914c-d965-421e-b6cf-330501bccaab"
        }
      ],
      "pickJobRef": "Pic50gpH7794X5NdMp3C",
      "processId": "text",
      "recipient": {
        "addressType": "POSTAL_ADDRESS",
        "companyName": "Speedy Boxales Ltd.",
        "coordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "email": "[email protected]",
        "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"
        }
      ],
      "tags": []
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

List pick jobs (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/pickjobs/search

HTTPcURLJavaScriptPython

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: 3845

{
  "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"
              ]
            },
            "facilityRef": {
              "eq": "text",
              "notEq": "text"
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "status": {
              "eq": "ABORTED",
              "in": [
                "ABORTED"
              ],
              "notEq": "ABORTED"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "tenantArticleIds": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "transfers": {
              "contains": {
                "id": {
                  "eq": "text",
                  "notEq": "text"
                }
              }
            }
          }
        ],
        "consumerName": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "facilityRef": {
          "eq": "text",
          "notEq": "text"
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "consumerName": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "facilityRef": {
              "eq": "text",
              "notEq": "text"
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "status": {
              "eq": "ABORTED",
              "in": [
                "ABORTED"
              ],
              "notEq": "ABORTED"
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "tenantArticleIds": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "transfers": {
              "contains": {
                "id": {
                  "eq": "text",
                  "notEq": "text"
                }
              }
            }
          }
        ],
        "status": {
          "eq": "ABORTED",
          "in": [
            "ABORTED"
          ],
          "notEq": "ABORTED"
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "tenantArticleIds": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "transfers": {
          "contains": {
            "id": {
              "eq": "text",
              "notEq": "text"
            }
          }
        }
      }
    ],
    "consumerName": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "facilityRef": {
      "eq": "text",
      "notEq": "text"
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "consumerName": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "facilityRef": {
          "eq": "text",
          "notEq": "text"
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "status": {
          "eq": "ABORTED",
          "in": [
            "ABORTED"
          ],
          "notEq": "ABORTED"
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "tenantArticleIds": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "transfers": {
          "contains": {
            "id": {
              "eq": "text",
              "notEq": "text"
            }
          }
        }
      }
    ],
    "status": {
      "eq": "ABORTED",
      "in": [
        "ABORTED"
      ],
      "notEq": "ABORTED"
    },
    "targetTime": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "tenantArticleIds": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "tenantOrderId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "transfers": {
      "contains": {
        "id": {
          "eq": "text",
          "notEq": "text"
        }
      }
    }
  },
  "size": 1,
  "sort": [
    {
      "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": "[email protected]",
              "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": "[email protected]",
              "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": "[email protected]",
              "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": "text",
            "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": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1
          },
          "customAttributes": {},
          "globalLineItemId": "a81f818e-2405-4570-8cde-b0c80fd3de31",
          "id": "climk4dcQFiPdA5ULuhS",
          "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"
          ],
          "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"
            }
          ],
          "measurementUnitKey": "liter",
          "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": []
          },
          "secondaryMeasurementUnitKey": "liter",
          "secondaryPicked": 20,
          "secondaryQuantity": 21,
          "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": "text",
                "tenantArticleId": "4711",
                "title": "Cologne Water",
                "weight": 1,
                "attributes": [
                  {
                    "valueLocalized": {
                      "de_DE": "Wert",
                      "en_US": "Value",
                      "ru_RU": "значение"
                    },
                    "keyLocalized": {
                      "de_DE": "Wert",
                      "en_US": "Value",
                      "ru_RU": "значение"
                    },
                    "category": "descriptive",
                    "context": {
                      "type": "FACILITY_GROUP",
                      "value": "text"
                    },
                    "key": "%%subtitle%%",
                    "priority": 100,
                    "type": "STRING",
                    "value": "585er Gold"
                  }
                ]
              },
              "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"
        }
      ],
      "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": [],
      "pickRunRef": "text",
      "resetBlocked": false,
      "subStatus": "SHORT_PICKED",
      "usersModificationHistory": [
        {
          "modificationDate": "2026-03-02T18:33:27.613Z",
          "userId": "text",
          "username": "text"
        }
      ]
    }
  ],
  "total": 1
}

List stow jobs (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/stowjobs/search

HTTPcURLJavaScriptPython

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: 9183

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "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": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "heldStockRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "stowTo": {
                  "contains": {
                    "storageLocationRef": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    },
                    "stowed": {
                      "stowedStockRef": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      },
                      "stowedStorageLocationRef": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      }
                    },
                    "type": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  }
                },
                "takeFrom": {
                  "storageLocationRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "taken": {
                    "takenStockRef": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  },
                  "type": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            }
          }
        ],
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "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": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "heldStockRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "stowTo": {
                  "contains": {
                    "storageLocationRef": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    },
                    "stowed": {
                      "stowedStockRef": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      },
                      "stowedStorageLocationRef": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      }
                    },
                    "type": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  }
                },
                "takeFrom": {
                  "storageLocationRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "taken": {
                    "takenStockRef": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  },
                  "type": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            },
            "targetTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            }
          }
        ],
        "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": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "heldStockRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "stowTo": {
              "contains": {
                "storageLocationRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "stowed": {
                  "stowedStockRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "stowedStorageLocationRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "type": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "takeFrom": {
              "storageLocationRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "taken": {
                "takenStockRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "type": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        }
      }
    ],
    "created": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "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": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "heldStockRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "stowTo": {
              "contains": {
                "storageLocationRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "stowed": {
                  "stowedStockRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "stowedStorageLocationRef": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "type": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "takeFrom": {
              "storageLocationRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "taken": {
                "takenStockRef": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "type": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        },
        "targetTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        }
      }
    ],
    "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": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "heldStockRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "stowTo": {
          "contains": {
            "storageLocationRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "stowed": {
              "stowedStockRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "stowedStorageLocationRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "type": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "takeFrom": {
          "storageLocationRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "taken": {
            "takenStockRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "type": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      }
    },
    "targetTime": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    }
  },
  "size": 1,
  "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-03-02T18:33:27.613Z",
      "customAttributes": {},
      "facilityRef": "text",
      "id": "text",
      "lastModified": "2026-03-02T18:33:27.613Z",
      "priority": 1,
      "shortId": "text",
      "status": "OPEN",
      "stowLineItems": [
        {
          "article": {
            "titleLocalized": {},
            "customAttributes": {},
            "imageUrl": "text",
            "measurementUnitKey": "text",
            "scannableCodes": [
              "text"
            ],
            "tenantArticleId": "text",
            "title": "text"
          },
          "customAttributes": {},
          "heldStockRef": "text",
          "id": "text",
          "reasons": [
            {
              "reasonLocalized": {},
              "tenantReasonId": "text"
            }
          ],
          "stowTo": [
            {
              "id": "text",
              "quantity": 1,
              "scannableCodes": [
                "text"
              ],
              "stockRef": "text",
              "storageLocationRef": "text",
              "stowed": {
                "stowedAt": "2026-03-02T18:33:27.613Z",
                "stowedQuantity": 1,
                "stowedStockRef": "text",
                "stowedStorageLocationRef": "text"
              },
              "type": "STOCK"
            }
          ],
          "takeFrom": {
            "quantity": 1,
            "scannableCodes": [
              "text"
            ],
            "stockInformation": {
              "properties": {
                "expiry": "text"
              },
              "traitConfig": [
                {
                  "enabled": true,
                  "trait": "text"
                }
              ]
            },
            "stockRef": "text",
            "storageLocationRef": "text",
            "taken": {
              "takenAt": "2026-03-02T18:33:27.613Z",
              "takenQuantity": 1,
              "takenStockRef": "text"
            },
            "type": "STOCK"
          }
        }
      ],
      "targetTime": "2026-03-02T18:33:27.613Z",
      "version": 1
    }
  ],
  "total": 1
}

List categories (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/categories/search

HTTPcURLJavaScriptPython

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: 2528

{
  "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": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "tenantCategoryId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "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": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "tenantCategoryId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "tenantCategoryId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "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": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "tenantCategoryId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "tenantCategoryId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "sort": [
    {
      "created": "ASC",
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "ASC",
      "lastModified": "ASC",
      "name": "ASC",
      "tenantCategoryId": "ASC"
    }
  ]
}

{
  "categories": [
    {
      "nameLocalized": {},
      "created": "2026-03-02T18:33:27.613Z",
      "customAttributes": {},
      "id": "text",
      "lastModified": "2026-03-02T18:33:27.613Z",
      "tenantCategoryId": "text",
      "version": 1
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

List facilities (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/facilities/search

HTTPcURLJavaScriptPython

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: 9110

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "address": {
      "city": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "country": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": {
          "eq": true,
          "notEq": true
        }
      },
      "emailAddresses": {
        "contains": {
          "recipient": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "value": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      },
      "houseNumber": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "postalCode": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "province": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "street": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "and": [
      {
        "address": {
          "city": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "country": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "customAttributes": {
            "ANY_ADDITIONAL_PROPERTY": {
              "eq": true,
              "notEq": true
            }
          },
          "emailAddresses": {
            "contains": {
              "recipient": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "value": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          },
          "houseNumber": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "postalCode": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "province": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "street": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "and": [
          {
            "address": {
              "city": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "country": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "customAttributes": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "eq": true,
                  "notEq": true
                }
              },
              "emailAddresses": {
                "contains": {
                  "recipient": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "value": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              },
              "houseNumber": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "postalCode": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "locationType": {
              "eq": "STORE",
              "in": [
                "STORE"
              ],
              "notEq": "STORE"
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "services": {
              "contains": {
                "type": {
                  "eq": "SHIP_FROM_STORE",
                  "in": [
                    "SHIP_FROM_STORE"
                  ],
                  "notEq": "SHIP_FROM_STORE"
                }
              }
            },
            "status": {
              "eq": "ONLINE",
              "in": [
                "ONLINE"
              ],
              "notEq": "ONLINE"
            },
            "tenantFacilityId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "type": {
              "eq": "MANAGED_FACILITY",
              "in": [
                "MANAGED_FACILITY"
              ],
              "notEq": "MANAGED_FACILITY"
            },
            "tags": {
              "contains": {
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "value": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "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
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "locationType": {
          "eq": "STORE",
          "in": [
            "STORE"
          ],
          "notEq": "STORE"
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "address": {
              "city": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "country": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "customAttributes": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "eq": true,
                  "notEq": true
                }
              },
              "emailAddresses": {
                "contains": {
                  "recipient": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "value": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              },
              "houseNumber": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "postalCode": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "locationType": {
              "eq": "STORE",
              "in": [
                "STORE"
              ],
              "notEq": "STORE"
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "services": {
              "contains": {
                "type": {
                  "eq": "SHIP_FROM_STORE",
                  "in": [
                    "SHIP_FROM_STORE"
                  ],
                  "notEq": "SHIP_FROM_STORE"
                }
              }
            },
            "status": {
              "eq": "ONLINE",
              "in": [
                "ONLINE"
              ],
              "notEq": "ONLINE"
            },
            "tenantFacilityId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "type": {
              "eq": "MANAGED_FACILITY",
              "in": [
                "MANAGED_FACILITY"
              ],
              "notEq": "MANAGED_FACILITY"
            },
            "tags": {
              "contains": {
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "value": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "services": {
          "contains": {
            "type": {
              "eq": "SHIP_FROM_STORE",
              "in": [
                "SHIP_FROM_STORE"
              ],
              "notEq": "SHIP_FROM_STORE"
            }
          }
        },
        "status": {
          "eq": "ONLINE",
          "in": [
            "ONLINE"
          ],
          "notEq": "ONLINE"
        },
        "tenantFacilityId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "type": {
          "eq": "MANAGED_FACILITY",
          "in": [
            "MANAGED_FACILITY"
          ],
          "notEq": "MANAGED_FACILITY"
        },
        "tags": {
          "contains": {
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "value": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "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
      }
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "locationType": {
      "eq": "STORE",
      "in": [
        "STORE"
      ],
      "notEq": "STORE"
    },
    "name": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "address": {
          "city": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "country": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "customAttributes": {
            "ANY_ADDITIONAL_PROPERTY": {
              "eq": true,
              "notEq": true
            }
          },
          "emailAddresses": {
            "contains": {
              "recipient": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "value": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          },
          "houseNumber": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "postalCode": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "locationType": {
          "eq": "STORE",
          "in": [
            "STORE"
          ],
          "notEq": "STORE"
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "services": {
          "contains": {
            "type": {
              "eq": "SHIP_FROM_STORE",
              "in": [
                "SHIP_FROM_STORE"
              ],
              "notEq": "SHIP_FROM_STORE"
            }
          }
        },
        "status": {
          "eq": "ONLINE",
          "in": [
            "ONLINE"
          ],
          "notEq": "ONLINE"
        },
        "tenantFacilityId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "type": {
          "eq": "MANAGED_FACILITY",
          "in": [
            "MANAGED_FACILITY"
          ],
          "notEq": "MANAGED_FACILITY"
        },
        "tags": {
          "contains": {
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "value": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "services": {
      "contains": {
        "type": {
          "eq": "SHIP_FROM_STORE",
          "in": [
            "SHIP_FROM_STORE"
          ],
          "notEq": "SHIP_FROM_STORE"
        }
      }
    },
    "status": {
      "eq": "ONLINE",
      "in": [
        "ONLINE"
      ],
      "notEq": "ONLINE"
    },
    "tenantFacilityId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "type": {
      "eq": "MANAGED_FACILITY",
      "in": [
        "MANAGED_FACILITY"
      ],
      "notEq": "MANAGED_FACILITY"
    },
    "tags": {
      "contains": {
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "value": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    }
  },
  "size": 1,
  "sort": [
    {
      "address": {
        "city": "ASC",
        "country": "ASC",
        "postalCode": "ASC"
      },
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "id": "ASC",
      "lastModified": "ASC",
      "name": "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": []
      },
      "services": [
        {
          "type": "SHIP_FROM_STORE"
        }
      ]
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

List reservations (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/reservations/search

HTTPcURLJavaScriptPython

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: 2646

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "relatedRefs": {
              "orderRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "pickJobRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "routingPlanRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "transferRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              }
            },
            "tenantArticleId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "relatedRefs": {
              "orderRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "pickJobRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "routingPlanRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              },
              "transferRefs": {
                "contains": {
                  "eq": "text",
                  "notEq": "text"
                }
              }
            },
            "tenantArticleId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "relatedRefs": {
          "orderRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "pickJobRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "routingPlanRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "transferRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          }
        },
        "tenantArticleId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "relatedRefs": {
          "orderRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "pickJobRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "routingPlanRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          },
          "transferRefs": {
            "contains": {
              "eq": "text",
              "notEq": "text"
            }
          }
        },
        "tenantArticleId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "relatedRefs": {
      "orderRefs": {
        "contains": {
          "eq": "text",
          "notEq": "text"
        }
      },
      "pickJobRefs": {
        "contains": {
          "eq": "text",
          "notEq": "text"
        }
      },
      "routingPlanRefs": {
        "contains": {
          "eq": "text",
          "notEq": "text"
        }
      },
      "transferRefs": {
        "contains": {
          "eq": "text",
          "notEq": "text"
        }
      }
    },
    "tenantArticleId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "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": {
        "orderRefs": [
          "text"
        ],
        "pickJobRefs": [
          "text"
        ],
        "processRefs": [
          "text"
        ],
        "routingPlanRefs": [
          "text"
        ],
        "transferRefs": [
          "text"
        ]
      },
      "tenantArticleId": "text",
      "version": 42
    }
  ],
  "total": 1
}

List handover job (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/handoverjobs/search

HTTPcURLJavaScriptPython

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: 13008

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "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"
                  ]
                }
              }
            },
            "channel": {
              "eq": "DELIVERY",
              "in": [
                "DELIVERY"
              ],
              "notEq": "DELIVERY"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "fullIdentifier": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "handoverJobLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "substituteLineItems": {
                  "contains": {
                    "article": {
                      "tenantArticleId": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "like": "text",
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      },
                      "title": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "like": "text",
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      }
                    }
                  }
                }
              }
            },
            "handoverJobParcelInfo": {
              "carrierKey": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "carrierRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "carrierTrackingNumber": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "shipmentRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "invoiceAddress": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
              "eq": "text",
              "notEq": "text"
            },
            "recipientAddress": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "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"
              ]
            }
          }
        },
        "channel": {
          "eq": "DELIVERY",
          "in": [
            "DELIVERY"
          ],
          "notEq": "DELIVERY"
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "fullIdentifier": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "handoverJobLineItems": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "substituteLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            }
          }
        },
        "handoverJobParcelInfo": {
          "carrierKey": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "carrierRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "carrierTrackingNumber": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "shipmentRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "invoiceAddress": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "firstName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "lastName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "or": [
          {
            "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"
                  ]
                }
              }
            },
            "channel": {
              "eq": "DELIVERY",
              "in": [
                "DELIVERY"
              ],
              "notEq": "DELIVERY"
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "fullIdentifier": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "handoverJobLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "substituteLineItems": {
                  "contains": {
                    "article": {
                      "tenantArticleId": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "like": "text",
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      },
                      "title": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "like": "text",
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      }
                    }
                  }
                }
              }
            },
            "handoverJobParcelInfo": {
              "carrierKey": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "carrierRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "carrierTrackingNumber": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "shipmentRef": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "invoiceAddress": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
              "eq": "text",
              "notEq": "text"
            },
            "recipientAddress": {
              "companyName": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "email": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "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": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "pickJobRef": {
          "eq": "text",
          "notEq": "text"
        },
        "recipientAddress": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "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"
          ]
        }
      }
    },
    "channel": {
      "eq": "DELIVERY",
      "in": [
        "DELIVERY"
      ],
      "notEq": "DELIVERY"
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "fullIdentifier": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "handoverJobLineItems": {
      "contains": {
        "article": {
          "tenantArticleId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "title": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "substituteLineItems": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          }
        }
      }
    },
    "handoverJobParcelInfo": {
      "carrierKey": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "carrierRef": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "carrierTrackingNumber": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "shipmentRef": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "invoiceAddress": {
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "email": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "firstName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "lastName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "or": [
      {
        "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"
              ]
            }
          }
        },
        "channel": {
          "eq": "DELIVERY",
          "in": [
            "DELIVERY"
          ],
          "notEq": "DELIVERY"
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "fullIdentifier": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "handoverJobLineItems": {
          "contains": {
            "article": {
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "title": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "substituteLineItems": {
              "contains": {
                "article": {
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  },
                  "title": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              }
            }
          }
        },
        "handoverJobParcelInfo": {
          "carrierKey": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "carrierRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "carrierTrackingNumber": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "shipmentRef": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "invoiceAddress": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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": {
          "eq": "text",
          "notEq": "text"
        },
        "recipientAddress": {
          "companyName": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "email": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "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": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "pickJobRef": {
      "eq": "text",
      "notEq": "text"
    },
    "recipientAddress": {
      "companyName": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "email": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "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": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "tenantOrderId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "sort": [
    {
      "targetTime": "ASC"
    }
  ]
}

{
  "handoverJobs": [
    {
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z",
      "version": 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": "text",
            "tenantArticleId": "4711",
            "title": "Cologne Water",
            "weight": 1,
            "attributes": [
              {
                "valueLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "keyLocalized": {
                  "de_DE": "Wert",
                  "en_US": "Value",
                  "ru_RU": "значение"
                },
                "category": "descriptive",
                "context": {
                  "type": "FACILITY_GROUP",
                  "value": "text"
                },
                "key": "%%subtitle%%",
                "priority": 100,
                "type": "STRING",
                "value": "585er Gold"
              }
            ]
          },
          "customAttributes": {},
          "quantity": 21,
          "scannableCodes": [
            "text"
          ],
          "status": "OPEN",
          "stickers": [],
          "transferId": "text",
          "tags": []
        }
      ],
      "facilityRef": "Esb20gpHBL94X5NdMp3C",
      "fullIdentifier": "text",
      "handoverJobLineItems": [
        {
          "article": {},
          "customAttributes": {},
          "globalLineItemId": "text",
          "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
          "quantity": 1,
          "recordableAttributes": [
            {
              "keyLocalized": {
                "de_DE": "Wert",
                "en_US": "Value",
                "ru_RU": "значение"
              },
              "group": "general",
              "id": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "key": "country of origin",
              "originId": "17ebfdfb-e1b4-4913-9962-3aef2b49f16f",
              "recordingRule": "MANDATORY",
              "value": "Germany"
            }
          ],
          "scannableCodes": [
            "text"
          ]
        }
      ],
      "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": "[email protected]",
        "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."
      },
      "loadUnitRefs": [
        "text"
      ],
      "operativeProcessRef": "text",
      "orderDate": "2020-02-03T08:45:50.525Z",
      "paid": false,
      "pickJobRef": "ca525716-7208-4a63-a2a6-11274eb37f67-0",
      "processId": "text",
      "recipientAddress": {
        "addressType": "POSTAL_ADDRESS",
        "companyName": "Speedy Boxales Ltd.",
        "coordinates": {
          "lat": 50.937531,
          "lon": 6.960279
        },
        "email": "[email protected]",
        "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."
      },
      "shortIdentifier": "text",
      "status": "OPEN",
      "stickers": [],
      "targetTime": "2026-03-02T18:33:27.613Z",
      "tenantOrderId": "R456728546",
      "transfers": [
        {
          "id": "018fe899-80ec-70f8-9bda-f7cc904bc0bf",
          "type": "RECEIVER"
        }
      ],
      "tags": []
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

List facility groups (search)

post

Search for FacilityGroup

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/facilitygroups/search

HTTPcURLJavaScriptPython

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: 1757

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "facilityRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "tenantFacilityGroupId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "facilityRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "facilityRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "tenantFacilityGroupId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "tenantFacilityGroupId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "facilityRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "name": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "facilityRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "tenantFacilityGroupId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "tenantFacilityGroupId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "sort": [
    {
      "name": "ASC"
    }
  ]
}

{
  "facilityGroups": [
    {
      "nameLocalized": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "created": "2026-03-02T18:33:27.613Z",
      "customAttributes": {},
      "facilityRefs": [
        "text"
      ],
      "id": "text",
      "lastModified": "2026-03-02T18:33:27.613Z",
      "name": "text",
      "tenantFacilityGroupId": "K12345",
      "version": 1
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

List inbound processes (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/inboundprocesses/search

HTTPcURLJavaScriptPython

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: 12391

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "inboundDate": {
              "contains": {
                "eq": "2026-03-02T18:33:27.613Z",
                "notEq": "2026-03-02T18:33:27.613Z"
              }
            },
            "or": "[Circular Reference]",
            "purchaseOrder": {
              "customAttributes": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "eq": true,
                  "notEq": true
                }
              },
              "id": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "orderDate": {
                "after": "text",
                "before": "text",
                "eq": "2026-03-02T18:33:27.613Z",
                "gt": "2026-03-02T18:33:27.613Z",
                "gte": "2026-03-02T18:33:27.613Z",
                "lt": "2026-03-02T18:33:27.613Z",
                "lte": "2026-03-02T18:33:27.613Z",
                "notEq": "2026-03-02T18:33:27.613Z"
              },
              "requestedDate": {
                "type": {
                  "eq": "ASAP",
                  "in": [
                    "ASAP"
                  ],
                  "notEq": "ASAP"
                },
                "value": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T18:33:27.613Z",
                  "gt": "2026-03-02T18:33:27.613Z",
                  "gte": "2026-03-02T18:33:27.613Z",
                  "lt": "2026-03-02T18:33:27.613Z",
                  "lte": "2026-03-02T18:33:27.613Z",
                  "notEq": "2026-03-02T18:33:27.613Z"
                }
              },
              "requestedItems": {
                "contains": {
                  "customAttributes": {
                    "ANY_ADDITIONAL_PROPERTY": {
                      "eq": true,
                      "notEq": true
                    }
                  },
                  "stockProperties": {
                    "ANY_ADDITIONAL_PROPERTY": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  },
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              },
              "status": {
                "eq": "OPEN",
                "in": [
                  "OPEN"
                ],
                "notEq": "OPEN"
              },
              "supplier": {
                "name": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "transfer": {
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "receipts": {
              "contains": {
                "customAttributes": {
                  "ANY_ADDITIONAL_PROPERTY": {
                    "eq": true,
                    "notEq": true
                  }
                },
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "receivedDate": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T18:33:27.613Z",
                  "gt": "2026-03-02T18:33:27.613Z",
                  "gte": "2026-03-02T18:33:27.613Z",
                  "lt": "2026-03-02T18:33:27.613Z",
                  "lte": "2026-03-02T18:33:27.613Z",
                  "notEq": "2026-03-02T18:33:27.613Z"
                },
                "receivedItems": {
                  "contains": {
                    "stockProperties": {
                      "ANY_ADDITIONAL_PROPERTY": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      }
                    },
                    "tenantArticleId": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  }
                },
                "status": {
                  "eq": "OPEN",
                  "in": [
                    "OPEN"
                  ],
                  "notEq": "OPEN"
                }
              }
            },
            "scannableCodes": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            },
            "tenantInboundProcessId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "inboundDate": {
          "contains": {
            "eq": "2026-03-02T18:33:27.613Z",
            "notEq": "2026-03-02T18:33:27.613Z"
          }
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "inboundDate": {
              "contains": {
                "eq": "2026-03-02T18:33:27.613Z",
                "notEq": "2026-03-02T18:33:27.613Z"
              }
            },
            "or": "[Circular Reference]",
            "purchaseOrder": {
              "customAttributes": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "eq": true,
                  "notEq": true
                }
              },
              "id": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "orderDate": {
                "after": "text",
                "before": "text",
                "eq": "2026-03-02T18:33:27.613Z",
                "gt": "2026-03-02T18:33:27.613Z",
                "gte": "2026-03-02T18:33:27.613Z",
                "lt": "2026-03-02T18:33:27.613Z",
                "lte": "2026-03-02T18:33:27.613Z",
                "notEq": "2026-03-02T18:33:27.613Z"
              },
              "requestedDate": {
                "type": {
                  "eq": "ASAP",
                  "in": [
                    "ASAP"
                  ],
                  "notEq": "ASAP"
                },
                "value": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T18:33:27.613Z",
                  "gt": "2026-03-02T18:33:27.613Z",
                  "gte": "2026-03-02T18:33:27.613Z",
                  "lt": "2026-03-02T18:33:27.613Z",
                  "lte": "2026-03-02T18:33:27.613Z",
                  "notEq": "2026-03-02T18:33:27.613Z"
                }
              },
              "requestedItems": {
                "contains": {
                  "customAttributes": {
                    "ANY_ADDITIONAL_PROPERTY": {
                      "eq": true,
                      "notEq": true
                    }
                  },
                  "stockProperties": {
                    "ANY_ADDITIONAL_PROPERTY": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  },
                  "tenantArticleId": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                }
              },
              "status": {
                "eq": "OPEN",
                "in": [
                  "OPEN"
                ],
                "notEq": "OPEN"
              },
              "supplier": {
                "name": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "transfer": {
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "receipts": {
              "contains": {
                "customAttributes": {
                  "ANY_ADDITIONAL_PROPERTY": {
                    "eq": true,
                    "notEq": true
                  }
                },
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "receivedDate": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T18:33:27.613Z",
                  "gt": "2026-03-02T18:33:27.613Z",
                  "gte": "2026-03-02T18:33:27.613Z",
                  "lt": "2026-03-02T18:33:27.613Z",
                  "lte": "2026-03-02T18:33:27.613Z",
                  "notEq": "2026-03-02T18:33:27.613Z"
                },
                "receivedItems": {
                  "contains": {
                    "stockProperties": {
                      "ANY_ADDITIONAL_PROPERTY": {
                        "eq": "text",
                        "in": [
                          "text"
                        ],
                        "notEq": "text",
                        "notIn": [
                          "text"
                        ]
                      }
                    },
                    "tenantArticleId": {
                      "eq": "text",
                      "in": [
                        "text"
                      ],
                      "notEq": "text",
                      "notIn": [
                        "text"
                      ]
                    }
                  }
                },
                "status": {
                  "eq": "OPEN",
                  "in": [
                    "OPEN"
                  ],
                  "notEq": "OPEN"
                }
              }
            },
            "scannableCodes": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            },
            "tenantInboundProcessId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "purchaseOrder": {
          "customAttributes": {
            "ANY_ADDITIONAL_PROPERTY": {
              "eq": true,
              "notEq": true
            }
          },
          "id": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "orderDate": {
            "after": "text",
            "before": "text",
            "eq": "2026-03-02T18:33:27.613Z",
            "gt": "2026-03-02T18:33:27.613Z",
            "gte": "2026-03-02T18:33:27.613Z",
            "lt": "2026-03-02T18:33:27.613Z",
            "lte": "2026-03-02T18:33:27.613Z",
            "notEq": "2026-03-02T18:33:27.613Z"
          },
          "requestedDate": {
            "type": {
              "eq": "ASAP",
              "in": [
                "ASAP"
              ],
              "notEq": "ASAP"
            },
            "value": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            }
          },
          "requestedItems": {
            "contains": {
              "customAttributes": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "eq": true,
                  "notEq": true
                }
              },
              "stockProperties": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          },
          "status": {
            "eq": "OPEN",
            "in": [
              "OPEN"
            ],
            "notEq": "OPEN"
          },
          "supplier": {
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "transfer": {
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "receipts": {
          "contains": {
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "receivedDate": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "receivedItems": {
              "contains": {
                "stockProperties": {
                  "ANY_ADDITIONAL_PROPERTY": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "tenantArticleId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            }
          }
        },
        "scannableCodes": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        },
        "tenantInboundProcessId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "inboundDate": {
      "contains": {
        "eq": "2026-03-02T18:33:27.613Z",
        "notEq": "2026-03-02T18:33:27.613Z"
      }
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "inboundDate": {
          "contains": {
            "eq": "2026-03-02T18:33:27.613Z",
            "notEq": "2026-03-02T18:33:27.613Z"
          }
        },
        "or": "[Circular Reference]",
        "purchaseOrder": {
          "customAttributes": {
            "ANY_ADDITIONAL_PROPERTY": {
              "eq": true,
              "notEq": true
            }
          },
          "id": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "orderDate": {
            "after": "text",
            "before": "text",
            "eq": "2026-03-02T18:33:27.613Z",
            "gt": "2026-03-02T18:33:27.613Z",
            "gte": "2026-03-02T18:33:27.613Z",
            "lt": "2026-03-02T18:33:27.613Z",
            "lte": "2026-03-02T18:33:27.613Z",
            "notEq": "2026-03-02T18:33:27.613Z"
          },
          "requestedDate": {
            "type": {
              "eq": "ASAP",
              "in": [
                "ASAP"
              ],
              "notEq": "ASAP"
            },
            "value": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            }
          },
          "requestedItems": {
            "contains": {
              "customAttributes": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "eq": true,
                  "notEq": true
                }
              },
              "stockProperties": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            }
          },
          "status": {
            "eq": "OPEN",
            "in": [
              "OPEN"
            ],
            "notEq": "OPEN"
          },
          "supplier": {
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "transfer": {
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "receipts": {
          "contains": {
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "receivedDate": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "receivedItems": {
              "contains": {
                "stockProperties": {
                  "ANY_ADDITIONAL_PROPERTY": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "tenantArticleId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            },
            "status": {
              "eq": "OPEN",
              "in": [
                "OPEN"
              ],
              "notEq": "OPEN"
            }
          }
        },
        "scannableCodes": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        },
        "tenantInboundProcessId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "purchaseOrder": {
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": {
          "eq": true,
          "notEq": true
        }
      },
      "id": {
        "eq": "text",
        "in": [
          "text"
        ],
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "orderDate": {
        "after": "text",
        "before": "text",
        "eq": "2026-03-02T18:33:27.613Z",
        "gt": "2026-03-02T18:33:27.613Z",
        "gte": "2026-03-02T18:33:27.613Z",
        "lt": "2026-03-02T18:33:27.613Z",
        "lte": "2026-03-02T18:33:27.613Z",
        "notEq": "2026-03-02T18:33:27.613Z"
      },
      "requestedDate": {
        "type": {
          "eq": "ASAP",
          "in": [
            "ASAP"
          ],
          "notEq": "ASAP"
        },
        "value": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        }
      },
      "requestedItems": {
        "contains": {
          "customAttributes": {
            "ANY_ADDITIONAL_PROPERTY": {
              "eq": true,
              "notEq": true
            }
          },
          "stockProperties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "tenantArticleId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        }
      },
      "status": {
        "eq": "OPEN",
        "in": [
          "OPEN"
        ],
        "notEq": "OPEN"
      },
      "supplier": {
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      },
      "transfer": {
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    },
    "receipts": {
      "contains": {
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "receivedDate": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "receivedItems": {
          "contains": {
            "stockProperties": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "tenantArticleId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        },
        "status": {
          "eq": "OPEN",
          "in": [
            "OPEN"
          ],
          "notEq": "OPEN"
        }
      }
    },
    "scannableCodes": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "status": {
      "eq": "OPEN",
      "in": [
        "OPEN"
      ],
      "notEq": "OPEN"
    },
    "tenantInboundProcessId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "sort": [
    {
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "lastModified": "ASC",
      "po_created": "ASC",
      "purchaseOrder": {
        "requestedDate": {
          "type": "ASC",
          "value": "ASC"
        },
        "supplier": {
          "name": "ASC"
        }
      }
    }
  ]
}

{
  "inboundProcesses": [
    {
      "anonymized": true,
      "created": "2026-03-02T18:33:27.613Z",
      "customAttributes": {},
      "facilityRef": "text",
      "id": "text",
      "inboundDate": [
        "2026-03-02T18:33:27.613Z"
      ],
      "lastModified": "2026-03-02T18:33:27.613Z",
      "onHold": true,
      "origin": [
        {
          "name": "text"
        }
      ],
      "purchaseOrder": {
        "created": "2026-03-02T18:33:27.613Z",
        "customAttributes": {},
        "id": "text",
        "lastModified": "2026-03-02T18:33:27.613Z",
        "orderDate": "2026-03-02T18:33:27.613Z",
        "requestedDate": {
          "type": "ASAP",
          "value": "2026-03-02T18:33:27.613Z"
        },
        "requestedItems": [
          {
            "customAttributes": {},
            "quantity": {
              "unit": "text",
              "value": 1
            },
            "stockProperties": {
              "expiry": "text"
            },
            "tenantArticleId": "text"
          }
        ],
        "status": "OPEN",
        "supplier": {
          "name": "text"
        },
        "transfer": {
          "id": "text"
        }
      },
      "receipts": [
        {
          "asnRef": "text",
          "comments": [
            {
              "content": "text",
              "documentSetRef": "text",
              "id": "text",
              "userRef": "text"
            }
          ],
          "customAttributes": {},
          "id": "text",
          "receivedDate": "2026-03-02T18:33:27.613Z",
          "receivedItems": [
            {
              "acceptedQuantity": {
                "unit": "text",
                "value": 1
              },
              "comments": [
                {
                  "content": "text",
                  "documentSetRef": "text",
                  "id": "text",
                  "userRef": "text"
                }
              ],
              "customAttributes": {},
              "id": "text",
              "rejectedQuantity": {
                "unit": "text",
                "value": 1
              },
              "stockProperties": {
                "expiry": "text"
              },
              "storageLocationRef": "text",
              "tenantArticleId": "text"
            }
          ],
          "status": "OPEN"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "status": "OPEN",
      "tenantInboundProcessId": "text",
      "version": 1
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

List storage locations (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/storagelocations/search

HTTPcURLJavaScriptPython

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: 5603

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "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": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "traits": {
              "contains": {
                "eq": "PICKABLE",
                "in": [
                  "PICKABLE"
                ],
                "notEq": "PICKABLE"
              }
            },
            "type": {
              "eq": "SINGLE_STORAGE",
              "in": [
                "SINGLE_STORAGE"
              ],
              "notEq": "SINGLE_STORAGE"
            },
            "zoneRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:33:27.613Z",
              "gt": "2026-03-02T18:33:27.613Z",
              "gte": "2026-03-02T18:33:27.613Z",
              "lt": "2026-03-02T18:33:27.613Z",
              "lte": "2026-03-02T18:33:27.613Z",
              "notEq": "2026-03-02T18:33:27.613Z"
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "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": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "traits": {
              "contains": {
                "eq": "PICKABLE",
                "in": [
                  "PICKABLE"
                ],
                "notEq": "PICKABLE"
              }
            },
            "type": {
              "eq": "SINGLE_STORAGE",
              "in": [
                "SINGLE_STORAGE"
              ],
              "notEq": "SINGLE_STORAGE"
            },
            "zoneRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "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": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "traits": {
          "contains": {
            "eq": "PICKABLE",
            "in": [
              "PICKABLE"
            ],
            "notEq": "PICKABLE"
          }
        },
        "type": {
          "eq": "SINGLE_STORAGE",
          "in": [
            "SINGLE_STORAGE"
          ],
          "notEq": "SINGLE_STORAGE"
        },
        "zoneRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "created": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:33:27.613Z",
      "gt": "2026-03-02T18:33:27.613Z",
      "gte": "2026-03-02T18:33:27.613Z",
      "lt": "2026-03-02T18:33:27.613Z",
      "lte": "2026-03-02T18:33:27.613Z",
      "notEq": "2026-03-02T18:33:27.613Z"
    },
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "name": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:33:27.613Z",
          "gt": "2026-03-02T18:33:27.613Z",
          "gte": "2026-03-02T18:33:27.613Z",
          "lt": "2026-03-02T18:33:27.613Z",
          "lte": "2026-03-02T18:33:27.613Z",
          "notEq": "2026-03-02T18:33:27.613Z"
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "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": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "traits": {
          "contains": {
            "eq": "PICKABLE",
            "in": [
              "PICKABLE"
            ],
            "notEq": "PICKABLE"
          }
        },
        "type": {
          "eq": "SINGLE_STORAGE",
          "in": [
            "SINGLE_STORAGE"
          ],
          "notEq": "SINGLE_STORAGE"
        },
        "zoneRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "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": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "traits": {
      "contains": {
        "eq": "PICKABLE",
        "in": [
          "PICKABLE"
        ],
        "notEq": "PICKABLE"
      }
    },
    "type": {
      "eq": "SINGLE_STORAGE",
      "in": [
        "SINGLE_STORAGE"
      ],
      "notEq": "SINGLE_STORAGE"
    },
    "zoneRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "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
}

List linked service jobs (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

LinkedServiceJobsSearchPayload

afterstringOptional

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

beforestringOptional

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

lastnumber · min: 1 · max: 250Optional

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

sizenumber · min: 1 · max: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

LinkedServiceJobsPaginatedResult

totalnumberOptional

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

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/linkedservicejobs/search

HTTPcURLJavaScriptPython

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

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

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

List all record items (search cached for 5 minutes)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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: 250Optional

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

startAfterIdstringOptionalDeprecated

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

Responses

200

Your search result

application/json

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

application/json

post

/api/lookuprecorditems/search

HTTPcURLJavaScriptPython

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: 2243

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "recordRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "tenantRecordId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "values": {
              "contains": {
                "attributeId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "attributeValue": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "recordRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "tenantRecordId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "values": {
              "contains": {
                "attributeId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "attributeValue": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "recordRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "tenantRecordId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "values": {
          "contains": {
            "attributeId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "attributeValue": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "recordRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "tenantRecordId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "values": {
          "contains": {
            "attributeId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "attributeValue": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "recordRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "tenantRecordId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "values": {
      "contains": {
        "attributeId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "attributeValue": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    }
  },
  "size": 1
}

{
  "lookupRecordItems": [
    {
      "id": "text",
      "recordRef": "text",
      "tenantRecordId": "text",
      "values": {
        "attributeId": "text",
        "attributeValue": "text"
      }
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}