Process endpoints

Create process reroute

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

processIdstringRequired

ID of process you want to reroute

Query parameters

versionnumberRequired

Version of process you want to reroute

rerouteDescriptionIdstringOptional

The id of the rerouteDescription

Responses

200

Process was found the corresponding reroute operations have been triggered.

application/json

Process

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Process not found

application/json

409

Process version conflict

application/json

post

/api/processes/{processId}/reroute

HTTPcURLJavaScriptPython

POST /api/processes/{processId}/reroute?version=1 HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "deletionDate": "2020-02-03T08:45:50.525Z",
  "documentRefs": [
    "text"
  ],
  "domainStatuses": {
    "ANY_ADDITIONAL_PROPERTY": "PENDING"
  },
  "domainStatusHistory": [
    {
      "domain": "ORDER",
      "domainEntityProcessStatus": "PENDING",
      "domainRef": "text",
      "statusChangeReasonKey": "text",
      "timestamp": "2020-02-03T08:45:50.525Z"
    }
  ],
  "domsStatus": "CREATED",
  "externalActionRefs": [
    "text"
  ],
  "facilityRefs": [
    "text"
  ],
  "flatRefs": [
    "text"
  ],
  "gdprCleanupDate": "2020-02-03T08:45:50.525Z",
  "handoverJobRefs": [
    "text"
  ],
  "id": "text",
  "inventoryStatus": "CREATED",
  "isAnonymized": true,
  "itemReturnJobsRef": [
    "text"
  ],
  "lastDomainEntityStatuses": [
    {
      "domain": "ORDER",
      "entityId": "text",
      "status": "PENDING"
    }
  ],
  "operativeStatus": "CREATED",
  "orderRef": "text",
  "packJobRefs": [
    "text"
  ],
  "pickJobRefs": [
    "text"
  ],
  "returnRefs": [
    "text"
  ],
  "returnStatus": "NOT_AVAILABLE",
  "routingPlanRefs": [
    "text"
  ],
  "serviceJobRefs": [
    "text"
  ],
  "shipmentRefs": [
    "text"
  ],
  "status": "CREATED",
  "tenantOrderId": "text",
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update process

patch

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

processIdstringRequired

ID of process you want to patch

Body

application/json

ProcessPatchActions

versioninteger · int64Required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Responses

200

Process was found & patch-set has been applied. The patched process is in the body.

application/json

Process

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Process not found

application/json

409

Process version conflict

application/json

patch

/api/processes/{processId}

HTTPcURLJavaScriptPython

PATCH /api/processes/{processId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "actions": [
    {
      "action": "AddTagsToProcess",
      "tags": []
    }
  ],
  "version": 42
}

{
  "deletionDate": "2020-02-03T08:45:50.525Z",
  "documentRefs": [
    "text"
  ],
  "domainStatuses": {
    "ANY_ADDITIONAL_PROPERTY": "PENDING"
  },
  "domainStatusHistory": [
    {
      "domain": "ORDER",
      "domainEntityProcessStatus": "PENDING",
      "domainRef": "text",
      "statusChangeReasonKey": "text",
      "timestamp": "2020-02-03T08:45:50.525Z"
    }
  ],
  "domsStatus": "CREATED",
  "externalActionRefs": [
    "text"
  ],
  "facilityRefs": [
    "text"
  ],
  "flatRefs": [
    "text"
  ],
  "gdprCleanupDate": "2020-02-03T08:45:50.525Z",
  "handoverJobRefs": [
    "text"
  ],
  "id": "text",
  "inventoryStatus": "CREATED",
  "isAnonymized": true,
  "itemReturnJobsRef": [
    "text"
  ],
  "lastDomainEntityStatuses": [
    {
      "domain": "ORDER",
      "entityId": "text",
      "status": "PENDING"
    }
  ],
  "operativeStatus": "CREATED",
  "orderRef": "text",
  "packJobRefs": [
    "text"
  ],
  "pickJobRefs": [
    "text"
  ],
  "returnRefs": [
    "text"
  ],
  "returnStatus": "NOT_AVAILABLE",
  "routingPlanRefs": [
    "text"
  ],
  "serviceJobRefs": [
    "text"
  ],
  "shipmentRefs": [
    "text"
  ],
  "status": "CREATED",
  "tenantOrderId": "text",
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

List processes (search)

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

ProcessSearchPayload

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

ProcessPaginatedResult

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/processes/search

HTTPcURLJavaScriptPython

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

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:31.187Z",
              "gt": "2026-03-02T18:02:31.187Z",
              "gte": "2026-03-02T18:02:31.187Z",
              "lt": "2026-03-02T18:02:31.187Z",
              "lte": "2026-03-02T18:02:31.187Z",
              "notEq": "2026-03-02T18:02:31.187Z"
            },
            "documentRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "domainStatuses": {
              "handover": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "order": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "packing": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "picking": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "return": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "routing": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "service": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "shipping": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              }
            },
            "domsStatus": {
              "eq": "CREATED",
              "in": [
                "CREATED"
              ],
              "notEq": "CREATED"
            },
            "externalActionRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "facilityRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "facilityRefsWithActiveOperations": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "flatRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "handoverJobRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "itemReturnJobsRef": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "operativeStatus": {
              "eq": "CREATED",
              "in": [
                "CREATED"
              ],
              "notEq": "CREATED"
            },
            "or": "[Circular Reference]",
            "orderRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "packJobRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "pickJobRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "processId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "referenced": {
              "brand": {
                "name": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "carrier": {
                "carrierTrackingNumber": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "name": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "consumerAddress": {
                "country": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "deliveryCountry": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "facility": {
                "address": {
                  "country": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "name": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "order": {
                "consumerId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "desiredDeliveryTime": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T18:02:31.187Z",
                  "gt": "2026-03-02T18:02:31.187Z",
                  "gte": "2026-03-02T18:02:31.187Z",
                  "lt": "2026-03-02T18:02:31.187Z",
                  "lte": "2026-03-02T18:02:31.187Z",
                  "notEq": "2026-03-02T18:02:31.187Z"
                },
                "orderDate": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T18:02:31.187Z",
                  "gt": "2026-03-02T18:02:31.187Z",
                  "gte": "2026-03-02T18:02:31.187Z",
                  "lt": "2026-03-02T18:02:31.187Z",
                  "lte": "2026-03-02T18:02:31.187Z",
                  "notEq": "2026-03-02T18:02:31.187Z"
                },
                "orderedAmount": {
                  "eq": 1,
                  "gt": 1,
                  "gte": 1,
                  "in": [
                    1
                  ],
                  "lt": 1,
                  "lte": 1,
                  "notEq": 1,
                  "notIn": [
                    1
                  ]
                },
                "provisioningTime": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T18:02:31.187Z",
                  "gt": "2026-03-02T18:02:31.187Z",
                  "gte": "2026-03-02T18:02:31.187Z",
                  "lt": "2026-03-02T18:02:31.187Z",
                  "lte": "2026-03-02T18:02:31.187Z",
                  "notEq": "2026-03-02T18:02:31.187Z"
                },
                "status": {
                  "contains": {
                    "eq": "OPEN",
                    "in": [
                      "OPEN"
                    ],
                    "notEq": "OPEN"
                  }
                },
                "tenantOrderId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "parcelTrackingStatus": {
                "contains": {
                  "eq": "REGISTERED",
                  "in": [
                    "REGISTERED"
                  ],
                  "notEq": "REGISTERED"
                }
              },
              "pickJob": {
                "shortId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "serviceLevel": {
                "contains": {
                  "eq": "DELIVERY",
                  "in": [
                    "DELIVERY"
                  ],
                  "notEq": "DELIVERY"
                }
              },
              "serviceType": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "sticker": {
                "name": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "targetTime": {
                "after": "text",
                "before": "text",
                "eq": "2026-03-02T18:02:31.187Z",
                "gt": "2026-03-02T18:02:31.187Z",
                "gte": "2026-03-02T18:02:31.187Z",
                "lt": "2026-03-02T18:02:31.187Z",
                "lte": "2026-03-02T18:02:31.187Z",
                "notEq": "2026-03-02T18:02:31.187Z"
              },
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "returnRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "returnStatus": {
              "eq": "CREATED",
              "in": [
                "CREATED"
              ],
              "notEq": "CREATED"
            },
            "routingPlanRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "searchTerm": {
              "like": "text"
            },
            "serviceJobRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "shipmentRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "status": {
              "eq": "CREATED",
              "in": [
                "CREATED"
              ],
              "notEq": "CREATED"
            },
            "tags": {
              "contains": {
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "value": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:02:31.187Z",
          "gt": "2026-03-02T18:02:31.187Z",
          "gte": "2026-03-02T18:02:31.187Z",
          "lt": "2026-03-02T18:02:31.187Z",
          "lte": "2026-03-02T18:02:31.187Z",
          "notEq": "2026-03-02T18:02:31.187Z"
        },
        "documentRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "domainStatuses": {
          "handover": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "order": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "packing": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "picking": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "return": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "routing": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "service": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "shipping": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          }
        },
        "domsStatus": {
          "eq": "CREATED",
          "in": [
            "CREATED"
          ],
          "notEq": "CREATED"
        },
        "externalActionRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "facilityRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "facilityRefsWithActiveOperations": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "flatRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "handoverJobRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "itemReturnJobsRef": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "operativeStatus": {
          "eq": "CREATED",
          "in": [
            "CREATED"
          ],
          "notEq": "CREATED"
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:31.187Z",
              "gt": "2026-03-02T18:02:31.187Z",
              "gte": "2026-03-02T18:02:31.187Z",
              "lt": "2026-03-02T18:02:31.187Z",
              "lte": "2026-03-02T18:02:31.187Z",
              "notEq": "2026-03-02T18:02:31.187Z"
            },
            "documentRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "domainStatuses": {
              "handover": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "order": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "packing": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "picking": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "return": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "routing": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "service": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              },
              "shipping": {
                "contains": {
                  "eq": "PENDING",
                  "in": [
                    "PENDING"
                  ],
                  "notEq": "PENDING"
                }
              }
            },
            "domsStatus": {
              "eq": "CREATED",
              "in": [
                "CREATED"
              ],
              "notEq": "CREATED"
            },
            "externalActionRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "facilityRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "facilityRefsWithActiveOperations": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "flatRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "handoverJobRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "itemReturnJobsRef": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "operativeStatus": {
              "eq": "CREATED",
              "in": [
                "CREATED"
              ],
              "notEq": "CREATED"
            },
            "or": "[Circular Reference]",
            "orderRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "packJobRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "pickJobRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "processId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "referenced": {
              "brand": {
                "name": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "carrier": {
                "carrierTrackingNumber": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "name": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "consumerAddress": {
                "country": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "deliveryCountry": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "facility": {
                "address": {
                  "country": {
                    "eq": "text",
                    "in": [
                      "text"
                    ],
                    "like": "text",
                    "notEq": "text",
                    "notIn": [
                      "text"
                    ]
                  }
                },
                "name": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "order": {
                "consumerId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "desiredDeliveryTime": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T18:02:31.187Z",
                  "gt": "2026-03-02T18:02:31.187Z",
                  "gte": "2026-03-02T18:02:31.187Z",
                  "lt": "2026-03-02T18:02:31.187Z",
                  "lte": "2026-03-02T18:02:31.187Z",
                  "notEq": "2026-03-02T18:02:31.187Z"
                },
                "orderDate": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T18:02:31.187Z",
                  "gt": "2026-03-02T18:02:31.187Z",
                  "gte": "2026-03-02T18:02:31.187Z",
                  "lt": "2026-03-02T18:02:31.187Z",
                  "lte": "2026-03-02T18:02:31.187Z",
                  "notEq": "2026-03-02T18:02:31.187Z"
                },
                "orderedAmount": {
                  "eq": 1,
                  "gt": 1,
                  "gte": 1,
                  "in": [
                    1
                  ],
                  "lt": 1,
                  "lte": 1,
                  "notEq": 1,
                  "notIn": [
                    1
                  ]
                },
                "provisioningTime": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T18:02:31.187Z",
                  "gt": "2026-03-02T18:02:31.187Z",
                  "gte": "2026-03-02T18:02:31.187Z",
                  "lt": "2026-03-02T18:02:31.187Z",
                  "lte": "2026-03-02T18:02:31.187Z",
                  "notEq": "2026-03-02T18:02:31.187Z"
                },
                "status": {
                  "contains": {
                    "eq": "OPEN",
                    "in": [
                      "OPEN"
                    ],
                    "notEq": "OPEN"
                  }
                },
                "tenantOrderId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "parcelTrackingStatus": {
                "contains": {
                  "eq": "REGISTERED",
                  "in": [
                    "REGISTERED"
                  ],
                  "notEq": "REGISTERED"
                }
              },
              "pickJob": {
                "shortId": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "serviceLevel": {
                "contains": {
                  "eq": "DELIVERY",
                  "in": [
                    "DELIVERY"
                  ],
                  "notEq": "DELIVERY"
                }
              },
              "serviceType": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              },
              "sticker": {
                "name": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "like": "text",
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              },
              "targetTime": {
                "after": "text",
                "before": "text",
                "eq": "2026-03-02T18:02:31.187Z",
                "gt": "2026-03-02T18:02:31.187Z",
                "gte": "2026-03-02T18:02:31.187Z",
                "lt": "2026-03-02T18:02:31.187Z",
                "lte": "2026-03-02T18:02:31.187Z",
                "notEq": "2026-03-02T18:02:31.187Z"
              },
              "tenantArticleId": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "returnRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "returnStatus": {
              "eq": "CREATED",
              "in": [
                "CREATED"
              ],
              "notEq": "CREATED"
            },
            "routingPlanRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "searchTerm": {
              "like": "text"
            },
            "serviceJobRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "shipmentRefs": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "status": {
              "eq": "CREATED",
              "in": [
                "CREATED"
              ],
              "notEq": "CREATED"
            },
            "tags": {
              "contains": {
                "id": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                },
                "value": {
                  "eq": "text",
                  "in": [
                    "text"
                  ],
                  "notEq": "text",
                  "notIn": [
                    "text"
                  ]
                }
              }
            }
          }
        ],
        "orderRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "packJobRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "pickJobRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "processId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "referenced": {
          "brand": {
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "carrier": {
            "carrierTrackingNumber": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "consumerAddress": {
            "country": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "deliveryCountry": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "facility": {
            "address": {
              "country": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "order": {
            "consumerId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "desiredDeliveryTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:31.187Z",
              "gt": "2026-03-02T18:02:31.187Z",
              "gte": "2026-03-02T18:02:31.187Z",
              "lt": "2026-03-02T18:02:31.187Z",
              "lte": "2026-03-02T18:02:31.187Z",
              "notEq": "2026-03-02T18:02:31.187Z"
            },
            "orderDate": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:31.187Z",
              "gt": "2026-03-02T18:02:31.187Z",
              "gte": "2026-03-02T18:02:31.187Z",
              "lt": "2026-03-02T18:02:31.187Z",
              "lte": "2026-03-02T18:02:31.187Z",
              "notEq": "2026-03-02T18:02:31.187Z"
            },
            "orderedAmount": {
              "eq": 1,
              "gt": 1,
              "gte": 1,
              "in": [
                1
              ],
              "lt": 1,
              "lte": 1,
              "notEq": 1,
              "notIn": [
                1
              ]
            },
            "provisioningTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:31.187Z",
              "gt": "2026-03-02T18:02:31.187Z",
              "gte": "2026-03-02T18:02:31.187Z",
              "lt": "2026-03-02T18:02:31.187Z",
              "lte": "2026-03-02T18:02:31.187Z",
              "notEq": "2026-03-02T18:02:31.187Z"
            },
            "status": {
              "contains": {
                "eq": "OPEN",
                "in": [
                  "OPEN"
                ],
                "notEq": "OPEN"
              }
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "parcelTrackingStatus": {
            "contains": {
              "eq": "REGISTERED",
              "in": [
                "REGISTERED"
              ],
              "notEq": "REGISTERED"
            }
          },
          "pickJob": {
            "shortId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "serviceLevel": {
            "contains": {
              "eq": "DELIVERY",
              "in": [
                "DELIVERY"
              ],
              "notEq": "DELIVERY"
            }
          },
          "serviceType": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "sticker": {
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "targetTime": {
            "after": "text",
            "before": "text",
            "eq": "2026-03-02T18:02:31.187Z",
            "gt": "2026-03-02T18:02:31.187Z",
            "gte": "2026-03-02T18:02:31.187Z",
            "lt": "2026-03-02T18:02:31.187Z",
            "lte": "2026-03-02T18:02:31.187Z",
            "notEq": "2026-03-02T18:02:31.187Z"
          },
          "tenantArticleId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "returnRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "returnStatus": {
          "eq": "CREATED",
          "in": [
            "CREATED"
          ],
          "notEq": "CREATED"
        },
        "routingPlanRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "searchTerm": {
          "like": "text"
        },
        "serviceJobRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "shipmentRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "status": {
          "eq": "CREATED",
          "in": [
            "CREATED"
          ],
          "notEq": "CREATED"
        },
        "tags": {
          "contains": {
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "value": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "created": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-02T18:02:31.187Z",
      "gt": "2026-03-02T18:02:31.187Z",
      "gte": "2026-03-02T18:02:31.187Z",
      "lt": "2026-03-02T18:02:31.187Z",
      "lte": "2026-03-02T18:02:31.187Z",
      "notEq": "2026-03-02T18:02:31.187Z"
    },
    "documentRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "domainStatuses": {
      "handover": {
        "contains": {
          "eq": "PENDING",
          "in": [
            "PENDING"
          ],
          "notEq": "PENDING"
        }
      },
      "order": {
        "contains": {
          "eq": "PENDING",
          "in": [
            "PENDING"
          ],
          "notEq": "PENDING"
        }
      },
      "packing": {
        "contains": {
          "eq": "PENDING",
          "in": [
            "PENDING"
          ],
          "notEq": "PENDING"
        }
      },
      "picking": {
        "contains": {
          "eq": "PENDING",
          "in": [
            "PENDING"
          ],
          "notEq": "PENDING"
        }
      },
      "return": {
        "contains": {
          "eq": "PENDING",
          "in": [
            "PENDING"
          ],
          "notEq": "PENDING"
        }
      },
      "routing": {
        "contains": {
          "eq": "PENDING",
          "in": [
            "PENDING"
          ],
          "notEq": "PENDING"
        }
      },
      "service": {
        "contains": {
          "eq": "PENDING",
          "in": [
            "PENDING"
          ],
          "notEq": "PENDING"
        }
      },
      "shipping": {
        "contains": {
          "eq": "PENDING",
          "in": [
            "PENDING"
          ],
          "notEq": "PENDING"
        }
      }
    },
    "domsStatus": {
      "eq": "CREATED",
      "in": [
        "CREATED"
      ],
      "notEq": "CREATED"
    },
    "externalActionRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "facilityRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "facilityRefsWithActiveOperations": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "flatRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "handoverJobRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "itemReturnJobsRef": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "operativeStatus": {
      "eq": "CREATED",
      "in": [
        "CREATED"
      ],
      "notEq": "CREATED"
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:02:31.187Z",
          "gt": "2026-03-02T18:02:31.187Z",
          "gte": "2026-03-02T18:02:31.187Z",
          "lt": "2026-03-02T18:02:31.187Z",
          "lte": "2026-03-02T18:02:31.187Z",
          "notEq": "2026-03-02T18:02:31.187Z"
        },
        "documentRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "domainStatuses": {
          "handover": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "order": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "packing": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "picking": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "return": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "routing": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "service": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          },
          "shipping": {
            "contains": {
              "eq": "PENDING",
              "in": [
                "PENDING"
              ],
              "notEq": "PENDING"
            }
          }
        },
        "domsStatus": {
          "eq": "CREATED",
          "in": [
            "CREATED"
          ],
          "notEq": "CREATED"
        },
        "externalActionRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "facilityRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "facilityRefsWithActiveOperations": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "flatRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "handoverJobRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "itemReturnJobsRef": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "operativeStatus": {
          "eq": "CREATED",
          "in": [
            "CREATED"
          ],
          "notEq": "CREATED"
        },
        "or": "[Circular Reference]",
        "orderRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "packJobRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "pickJobRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "processId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "referenced": {
          "brand": {
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "carrier": {
            "carrierTrackingNumber": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "consumerAddress": {
            "country": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "deliveryCountry": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "facility": {
            "address": {
              "country": {
                "eq": "text",
                "in": [
                  "text"
                ],
                "like": "text",
                "notEq": "text",
                "notIn": [
                  "text"
                ]
              }
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "order": {
            "consumerId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "desiredDeliveryTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:31.187Z",
              "gt": "2026-03-02T18:02:31.187Z",
              "gte": "2026-03-02T18:02:31.187Z",
              "lt": "2026-03-02T18:02:31.187Z",
              "lte": "2026-03-02T18:02:31.187Z",
              "notEq": "2026-03-02T18:02:31.187Z"
            },
            "orderDate": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:31.187Z",
              "gt": "2026-03-02T18:02:31.187Z",
              "gte": "2026-03-02T18:02:31.187Z",
              "lt": "2026-03-02T18:02:31.187Z",
              "lte": "2026-03-02T18:02:31.187Z",
              "notEq": "2026-03-02T18:02:31.187Z"
            },
            "orderedAmount": {
              "eq": 1,
              "gt": 1,
              "gte": 1,
              "in": [
                1
              ],
              "lt": 1,
              "lte": 1,
              "notEq": 1,
              "notIn": [
                1
              ]
            },
            "provisioningTime": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:31.187Z",
              "gt": "2026-03-02T18:02:31.187Z",
              "gte": "2026-03-02T18:02:31.187Z",
              "lt": "2026-03-02T18:02:31.187Z",
              "lte": "2026-03-02T18:02:31.187Z",
              "notEq": "2026-03-02T18:02:31.187Z"
            },
            "status": {
              "contains": {
                "eq": "OPEN",
                "in": [
                  "OPEN"
                ],
                "notEq": "OPEN"
              }
            },
            "tenantOrderId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "parcelTrackingStatus": {
            "contains": {
              "eq": "REGISTERED",
              "in": [
                "REGISTERED"
              ],
              "notEq": "REGISTERED"
            }
          },
          "pickJob": {
            "shortId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "serviceLevel": {
            "contains": {
              "eq": "DELIVERY",
              "in": [
                "DELIVERY"
              ],
              "notEq": "DELIVERY"
            }
          },
          "serviceType": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          },
          "sticker": {
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "like": "text",
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          },
          "targetTime": {
            "after": "text",
            "before": "text",
            "eq": "2026-03-02T18:02:31.187Z",
            "gt": "2026-03-02T18:02:31.187Z",
            "gte": "2026-03-02T18:02:31.187Z",
            "lt": "2026-03-02T18:02:31.187Z",
            "lte": "2026-03-02T18:02:31.187Z",
            "notEq": "2026-03-02T18:02:31.187Z"
          },
          "tenantArticleId": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "returnRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "returnStatus": {
          "eq": "CREATED",
          "in": [
            "CREATED"
          ],
          "notEq": "CREATED"
        },
        "routingPlanRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "searchTerm": {
          "like": "text"
        },
        "serviceJobRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "shipmentRefs": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "status": {
          "eq": "CREATED",
          "in": [
            "CREATED"
          ],
          "notEq": "CREATED"
        },
        "tags": {
          "contains": {
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "value": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        }
      }
    ],
    "orderRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "packJobRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "pickJobRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "processId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "like": "text",
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "referenced": {
      "brand": {
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      },
      "carrier": {
        "carrierTrackingNumber": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      },
      "consumerAddress": {
        "country": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "deliveryCountry": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      },
      "facility": {
        "address": {
          "country": {
            "eq": "text",
            "in": [
              "text"
            ],
            "like": "text",
            "notEq": "text",
            "notIn": [
              "text"
            ]
          }
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      },
      "order": {
        "consumerId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "desiredDeliveryTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:02:31.187Z",
          "gt": "2026-03-02T18:02:31.187Z",
          "gte": "2026-03-02T18:02:31.187Z",
          "lt": "2026-03-02T18:02:31.187Z",
          "lte": "2026-03-02T18:02:31.187Z",
          "notEq": "2026-03-02T18:02:31.187Z"
        },
        "orderDate": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:02:31.187Z",
          "gt": "2026-03-02T18:02:31.187Z",
          "gte": "2026-03-02T18:02:31.187Z",
          "lt": "2026-03-02T18:02:31.187Z",
          "lte": "2026-03-02T18:02:31.187Z",
          "notEq": "2026-03-02T18:02:31.187Z"
        },
        "orderedAmount": {
          "eq": 1,
          "gt": 1,
          "gte": 1,
          "in": [
            1
          ],
          "lt": 1,
          "lte": 1,
          "notEq": 1,
          "notIn": [
            1
          ]
        },
        "provisioningTime": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:02:31.187Z",
          "gt": "2026-03-02T18:02:31.187Z",
          "gte": "2026-03-02T18:02:31.187Z",
          "lt": "2026-03-02T18:02:31.187Z",
          "lte": "2026-03-02T18:02:31.187Z",
          "notEq": "2026-03-02T18:02:31.187Z"
        },
        "status": {
          "contains": {
            "eq": "OPEN",
            "in": [
              "OPEN"
            ],
            "notEq": "OPEN"
          }
        },
        "tenantOrderId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      },
      "parcelTrackingStatus": {
        "contains": {
          "eq": "REGISTERED",
          "in": [
            "REGISTERED"
          ],
          "notEq": "REGISTERED"
        }
      },
      "pickJob": {
        "shortId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      },
      "serviceLevel": {
        "contains": {
          "eq": "DELIVERY",
          "in": [
            "DELIVERY"
          ],
          "notEq": "DELIVERY"
        }
      },
      "serviceType": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      },
      "sticker": {
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "like": "text",
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      },
      "targetTime": {
        "after": "text",
        "before": "text",
        "eq": "2026-03-02T18:02:31.187Z",
        "gt": "2026-03-02T18:02:31.187Z",
        "gte": "2026-03-02T18:02:31.187Z",
        "lt": "2026-03-02T18:02:31.187Z",
        "lte": "2026-03-02T18:02:31.187Z",
        "notEq": "2026-03-02T18:02:31.187Z"
      },
      "tenantArticleId": {
        "eq": "text",
        "in": [
          "text"
        ],
        "like": "text",
        "notEq": "text",
        "notIn": [
          "text"
        ]
      }
    },
    "returnRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "returnStatus": {
      "eq": "CREATED",
      "in": [
        "CREATED"
      ],
      "notEq": "CREATED"
    },
    "routingPlanRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "searchTerm": {
      "like": "text"
    },
    "serviceJobRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "shipmentRefs": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "status": {
      "eq": "CREATED",
      "in": [
        "CREATED"
      ],
      "notEq": "CREATED"
    },
    "tags": {
      "contains": {
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "value": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    }
  },
  "size": 1,
  "sort": [
    {
      "domsStatus": "ASC",
      "operativeStatus": "ASC",
      "processId": "ASC",
      "referenced": {
        "brand": {
          "name": "ASC"
        },
        "carrier": {
          "name": "ASC"
        },
        "consumerAddress": {
          "country": "ASC",
          "postalCode": "ASC"
        },
        "facility": {
          "address": {
            "country": "ASC"
          },
          "name": "ASC"
        },
        "order": {
          "desiredDeliveryTime": "ASC",
          "orderDate": "ASC",
          "orderedAmount": "ASC",
          "provisioningTime": "ASC",
          "tenantOrderId": "ASC",
          "updateDetails": {
            "created": "ASC",
            "user": "ASC"
          }
        },
        "parcelTrackingStatus": "ASC",
        "sticker": {
          "name": "ASC"
        },
        "targetTime": "ASC"
      },
      "returnStatus": "ASC",
      "status": "ASC"
    }
  ]
}

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

Get process

get

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

tenantOrderIdstringOptional

orderRefstringOptional

pickJobRefstringOptional

shipmentRefstringOptional

handoverJobRefstringOptional

returnRefstringOptional

Responses

200

Process belonging to the given parameters

application/json

Process

400

The given parameters are invalid

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Entity not found

application/json

get

/api/process

HTTPcURLJavaScriptPython

GET /api/process HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "deletionDate": "2020-02-03T08:45:50.525Z",
  "documentRefs": [
    "text"
  ],
  "domainStatuses": {
    "ANY_ADDITIONAL_PROPERTY": "PENDING"
  },
  "domainStatusHistory": [
    {
      "domain": "ORDER",
      "domainEntityProcessStatus": "PENDING",
      "domainRef": "text",
      "statusChangeReasonKey": "text",
      "timestamp": "2020-02-03T08:45:50.525Z"
    }
  ],
  "domsStatus": "CREATED",
  "externalActionRefs": [
    "text"
  ],
  "facilityRefs": [
    "text"
  ],
  "flatRefs": [
    "text"
  ],
  "gdprCleanupDate": "2020-02-03T08:45:50.525Z",
  "handoverJobRefs": [
    "text"
  ],
  "id": "text",
  "inventoryStatus": "CREATED",
  "isAnonymized": true,
  "itemReturnJobsRef": [
    "text"
  ],
  "lastDomainEntityStatuses": [
    {
      "domain": "ORDER",
      "entityId": "text",
      "status": "PENDING"
    }
  ],
  "operativeStatus": "CREATED",
  "orderRef": "text",
  "packJobRefs": [
    "text"
  ],
  "pickJobRefs": [
    "text"
  ],
  "returnRefs": [
    "text"
  ],
  "returnStatus": "NOT_AVAILABLE",
  "routingPlanRefs": [
    "text"
  ],
  "serviceJobRefs": [
    "text"
  ],
  "shipmentRefs": [
    "text"
  ],
  "status": "CREATED",
  "tenantOrderId": "text",
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get process

get

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

processIdstringRequired

Responses

200

The found process.

application/json

Process

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

Entity not found

application/json

get

/api/processes/{processId}

HTTPcURLJavaScriptPython

GET /api/processes/{processId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "deletionDate": "2020-02-03T08:45:50.525Z",
  "documentRefs": [
    "text"
  ],
  "domainStatuses": {
    "ANY_ADDITIONAL_PROPERTY": "PENDING"
  },
  "domainStatusHistory": [
    {
      "domain": "ORDER",
      "domainEntityProcessStatus": "PENDING",
      "domainRef": "text",
      "statusChangeReasonKey": "text",
      "timestamp": "2020-02-03T08:45:50.525Z"
    }
  ],
  "domsStatus": "CREATED",
  "externalActionRefs": [
    "text"
  ],
  "facilityRefs": [
    "text"
  ],
  "flatRefs": [
    "text"
  ],
  "gdprCleanupDate": "2020-02-03T08:45:50.525Z",
  "handoverJobRefs": [
    "text"
  ],
  "id": "text",
  "inventoryStatus": "CREATED",
  "isAnonymized": true,
  "itemReturnJobsRef": [
    "text"
  ],
  "lastDomainEntityStatuses": [
    {
      "domain": "ORDER",
      "entityId": "text",
      "status": "PENDING"
    }
  ],
  "operativeStatus": "CREATED",
  "orderRef": "text",
  "packJobRefs": [
    "text"
  ],
  "pickJobRefs": [
    "text"
  ],
  "returnRefs": [
    "text"
  ],
  "returnStatus": "NOT_AVAILABLE",
  "routingPlanRefs": [
    "text"
  ],
  "serviceJobRefs": [
    "text"
  ],
  "shipmentRefs": [
    "text"
  ],
  "status": "CREATED",
  "tenantOrderId": "text",
  "tags": [],
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Get process history logs

get

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Return all logs for a given process.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

processIdstringRequired

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25

filterConsecutiveDuplicatesbooleanOptional

control whether you want to filter consecutive duplicate logs

Default: true

Responses

200

The process logs which were found in response body

application/json

ProcessHistoryLogs

totalintegerOptional

Total number of found entities for this query

Example: 3

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

get

/api/processes/{processId}/historylogs

HTTPcURLJavaScriptPython

GET /api/processes/{processId}/historylogs HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "historyLogs": [
    {
      "domain": "ORDER",
      "domainRef": "text",
      "eventCause": "text",
      "id": "text",
      "status": "text",
      "timestamp": "2025-01-01T08:45:50.525Z",
      "type": "text",
      "user": {
        "username": "text",
        "userRef": "text"
      },
      "version": 1,
      "info": "text"
    }
  ],
  "total": 3
}

Create process document

post

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

processIdstringRequired

Body

application/json

ExternalDocumentForCreation

prioritynumberOptional

sectionstring · enumRequired

Section

Possible values:

typestring · enumRequired

DocumentType

Possible values:

Responses

201

The document was successfully created

application/json

400

Invalid input. See response for details

application/json

post

/api/processes/{processId}/documents

HTTPcURLJavaScriptPython

POST /api/processes/{processId}/documents HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1076

{
  "file": {
    "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
    "name": "example.pdf"
  },
  "priority": 1,
  "section": "ORDER",
  "type": "PDF"
}

{
  "id": "text",
  "name": "text",
  "path": "text",
  "priority": 1,
  "section": "ORDER",
  "type": "PDF",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

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:02:31.187Z",
                "notEq": "2026-03-02T18:02:31.187Z"
              }
            },
            "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:02:31.187Z",
                "gt": "2026-03-02T18:02:31.187Z",
                "gte": "2026-03-02T18:02:31.187Z",
                "lt": "2026-03-02T18:02:31.187Z",
                "lte": "2026-03-02T18:02:31.187Z",
                "notEq": "2026-03-02T18:02:31.187Z"
              },
              "requestedDate": {
                "type": {
                  "eq": "ASAP",
                  "in": [
                    "ASAP"
                  ],
                  "notEq": "ASAP"
                },
                "value": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T18:02:31.187Z",
                  "gt": "2026-03-02T18:02:31.187Z",
                  "gte": "2026-03-02T18:02:31.187Z",
                  "lt": "2026-03-02T18:02:31.187Z",
                  "lte": "2026-03-02T18:02:31.187Z",
                  "notEq": "2026-03-02T18:02:31.187Z"
                }
              },
              "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:02:31.187Z",
                  "gt": "2026-03-02T18:02:31.187Z",
                  "gte": "2026-03-02T18:02:31.187Z",
                  "lt": "2026-03-02T18:02:31.187Z",
                  "lte": "2026-03-02T18:02:31.187Z",
                  "notEq": "2026-03-02T18:02:31.187Z"
                },
                "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:02:31.187Z",
            "notEq": "2026-03-02T18:02:31.187Z"
          }
        },
        "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:02:31.187Z",
                "notEq": "2026-03-02T18:02:31.187Z"
              }
            },
            "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:02:31.187Z",
                "gt": "2026-03-02T18:02:31.187Z",
                "gte": "2026-03-02T18:02:31.187Z",
                "lt": "2026-03-02T18:02:31.187Z",
                "lte": "2026-03-02T18:02:31.187Z",
                "notEq": "2026-03-02T18:02:31.187Z"
              },
              "requestedDate": {
                "type": {
                  "eq": "ASAP",
                  "in": [
                    "ASAP"
                  ],
                  "notEq": "ASAP"
                },
                "value": {
                  "after": "text",
                  "before": "text",
                  "eq": "2026-03-02T18:02:31.187Z",
                  "gt": "2026-03-02T18:02:31.187Z",
                  "gte": "2026-03-02T18:02:31.187Z",
                  "lt": "2026-03-02T18:02:31.187Z",
                  "lte": "2026-03-02T18:02:31.187Z",
                  "notEq": "2026-03-02T18:02:31.187Z"
                }
              },
              "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:02:31.187Z",
                  "gt": "2026-03-02T18:02:31.187Z",
                  "gte": "2026-03-02T18:02:31.187Z",
                  "lt": "2026-03-02T18:02:31.187Z",
                  "lte": "2026-03-02T18:02:31.187Z",
                  "notEq": "2026-03-02T18:02:31.187Z"
                },
                "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:02:31.187Z",
            "gt": "2026-03-02T18:02:31.187Z",
            "gte": "2026-03-02T18:02:31.187Z",
            "lt": "2026-03-02T18:02:31.187Z",
            "lte": "2026-03-02T18:02:31.187Z",
            "notEq": "2026-03-02T18:02:31.187Z"
          },
          "requestedDate": {
            "type": {
              "eq": "ASAP",
              "in": [
                "ASAP"
              ],
              "notEq": "ASAP"
            },
            "value": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:31.187Z",
              "gt": "2026-03-02T18:02:31.187Z",
              "gte": "2026-03-02T18:02:31.187Z",
              "lt": "2026-03-02T18:02:31.187Z",
              "lte": "2026-03-02T18:02:31.187Z",
              "notEq": "2026-03-02T18:02:31.187Z"
            }
          },
          "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:02:31.187Z",
              "gt": "2026-03-02T18:02:31.187Z",
              "gte": "2026-03-02T18:02:31.187Z",
              "lt": "2026-03-02T18:02:31.187Z",
              "lte": "2026-03-02T18:02:31.187Z",
              "notEq": "2026-03-02T18:02:31.187Z"
            },
            "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:02:31.187Z",
        "notEq": "2026-03-02T18:02:31.187Z"
      }
    },
    "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:02:31.187Z",
            "notEq": "2026-03-02T18:02:31.187Z"
          }
        },
        "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:02:31.187Z",
            "gt": "2026-03-02T18:02:31.187Z",
            "gte": "2026-03-02T18:02:31.187Z",
            "lt": "2026-03-02T18:02:31.187Z",
            "lte": "2026-03-02T18:02:31.187Z",
            "notEq": "2026-03-02T18:02:31.187Z"
          },
          "requestedDate": {
            "type": {
              "eq": "ASAP",
              "in": [
                "ASAP"
              ],
              "notEq": "ASAP"
            },
            "value": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-02T18:02:31.187Z",
              "gt": "2026-03-02T18:02:31.187Z",
              "gte": "2026-03-02T18:02:31.187Z",
              "lt": "2026-03-02T18:02:31.187Z",
              "lte": "2026-03-02T18:02:31.187Z",
              "notEq": "2026-03-02T18:02:31.187Z"
            }
          },
          "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:02:31.187Z",
              "gt": "2026-03-02T18:02:31.187Z",
              "gte": "2026-03-02T18:02:31.187Z",
              "lt": "2026-03-02T18:02:31.187Z",
              "lte": "2026-03-02T18:02:31.187Z",
              "notEq": "2026-03-02T18:02:31.187Z"
            },
            "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:02:31.187Z",
        "gt": "2026-03-02T18:02:31.187Z",
        "gte": "2026-03-02T18:02:31.187Z",
        "lt": "2026-03-02T18:02:31.187Z",
        "lte": "2026-03-02T18:02:31.187Z",
        "notEq": "2026-03-02T18:02:31.187Z"
      },
      "requestedDate": {
        "type": {
          "eq": "ASAP",
          "in": [
            "ASAP"
          ],
          "notEq": "ASAP"
        },
        "value": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-02T18:02:31.187Z",
          "gt": "2026-03-02T18:02:31.187Z",
          "gte": "2026-03-02T18:02:31.187Z",
          "lt": "2026-03-02T18:02:31.187Z",
          "lte": "2026-03-02T18:02:31.187Z",
          "notEq": "2026-03-02T18:02:31.187Z"
        }
      },
      "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:02:31.187Z",
          "gt": "2026-03-02T18:02:31.187Z",
          "gte": "2026-03-02T18:02:31.187Z",
          "lt": "2026-03-02T18:02:31.187Z",
          "lte": "2026-03-02T18:02:31.187Z",
          "notEq": "2026-03-02T18:02:31.187Z"
        },
        "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:02:31.187Z",
      "customAttributes": {},
      "facilityRef": "text",
      "id": "text",
      "inboundDate": [
        "2026-03-02T18:02:31.187Z"
      ],
      "lastModified": "2026-03-02T18:02:31.187Z",
      "onHold": true,
      "origin": [
        {
          "name": "text"
        }
      ],
      "purchaseOrder": {
        "created": "2026-03-02T18:02:31.187Z",
        "customAttributes": {},
        "id": "text",
        "lastModified": "2026-03-02T18:02:31.187Z",
        "orderDate": "2026-03-02T18:02:31.187Z",
        "requestedDate": {
          "type": "ASAP",
          "value": "2026-03-02T18:02:31.187Z"
        },
        "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:02:31.187Z",
          "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
}

Create inbound process

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

InboundProcessForCreation

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

facilityRefstringRequired

Facility in which the inbound process takes place

onHoldbooleanOptional

Indicates if the inbound process is on hold and will not be processed further

scannableCodesstring[]Optional

scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note

tenantInboundProcessIdstringOptional

Identifier of the process provided by the tenant system. It is recommended to be unique

Responses

200

Created Inbound Process entity

application/json

InboundProcess

anonymizedbooleanRequired

Indicates the inbound process was anonymized acording to configured GDPR retention time.

createdstring · date-timeRequired

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

facilityRefstringRequired

idstringRequired

inboundDatestring · date-time[]Required

Aggregated dates from sources which advise incoming stock. Currently that is "purchaseOrder"

lastModifiedstring · date-timeRequired

onHoldbooleanRequired

Indicates if the inbound process is on hold and will not be processed further

scannableCodesstring[]Required

scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note

statusstring · enumRequiredPossible values:

tenantInboundProcessIdstringOptional

versionnumberRequired

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

HTTPcURLJavaScriptPython

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

{
  "customAttributes": {},
  "facilityRef": "text",
  "onHold": true,
  "purchaseOrder": {
    "customAttributes": {},
    "orderDate": "2026-03-02T18:02:31.187Z",
    "requestedDate": {
      "type": "ASAP",
      "value": "2026-03-02T18:02:31.187Z"
    },
    "requestedItems": [
      {
        "customAttributes": {},
        "quantity": {
          "unit": "text",
          "value": 1
        },
        "stockProperties": {
          "expiry": "text"
        },
        "tenantArticleId": "text"
      }
    ],
    "status": "OPEN",
    "supplier": {
      "name": "text"
    }
  },
  "receipts": [
    {
      "asnRef": "text",
      "comments": [
        {
          "content": "text",
          "userRef": "text"
        }
      ],
      "customAttributes": {},
      "receivedDate": "2026-03-02T18:02:31.187Z",
      "receivedItems": [
        {
          "acceptedQuantity": {
            "unit": "text",
            "value": 1
          },
          "comments": [
            {
              "content": "text",
              "userRef": "text"
            }
          ],
          "customAttributes": {},
          "rejectedQuantity": {
            "unit": "text",
            "value": 1
          },
          "stockProperties": {
            "expiry": "text"
          },
          "storageLocationRef": "text",
          "tenantArticleId": "text"
        }
      ],
      "status": "OPEN"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "tenantInboundProcessId": "text"
}

{
  "anonymized": true,
  "created": "2026-03-02T18:02:31.187Z",
  "customAttributes": {},
  "facilityRef": "text",
  "id": "text",
  "inboundDate": [
    "2026-03-02T18:02:31.187Z"
  ],
  "lastModified": "2026-03-02T18:02:31.187Z",
  "onHold": true,
  "origin": [
    {
      "name": "text"
    }
  ],
  "purchaseOrder": {
    "created": "2026-03-02T18:02:31.187Z",
    "customAttributes": {},
    "id": "text",
    "lastModified": "2026-03-02T18:02:31.187Z",
    "orderDate": "2026-03-02T18:02:31.187Z",
    "requestedDate": {
      "type": "ASAP",
      "value": "2026-03-02T18:02:31.187Z"
    },
    "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:02:31.187Z",
      "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
}

Get process document

get

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

processIdstringRequired

documentIdstringRequired

Responses

200

The document meta information with given id attached to the selected process

application/json

ExternalDocument

get

/api/processes/{processId}/documents/{documentId}

HTTPcURLJavaScriptPython

GET /api/processes/{processId}/documents/{documentId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The document meta information with given id attached to the selected process

{
  "id": "text",
  "name": "text",
  "path": "text",
  "priority": 1,
  "section": "ORDER",
  "type": "PDF",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Update process file

put

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

processIdstringRequired

documentIdstringRequired

Body

application/json

ExternalDocumentForUpdate

Responses

200

The document was successfully updated

application/json

ExternalDocument

400

Invalid input. See response for details

application/json

put

/api/processes/{processId}/documents/{documentId}/file

HTTPcURLJavaScriptPython

PUT /api/processes/{processId}/documents/{documentId}/file HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1124

{
  "file": {
    "content": "JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
    "name": "example.pdf"
  },
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

{
  "id": "text",
  "name": "text",
  "path": "text",
  "priority": 1,
  "section": "ORDER",
  "type": "PDF",
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Download process file

get

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

processIdstringRequired

documentIdstringRequired

Responses

200

The document with given id attached to the selected process

application/pdf

get

/api/processes/{processId}/documents/{documentId}/file

HTTPcURLJavaScriptPython

GET /api/processes/{processId}/documents/{documentId}/file HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The document with given id attached to the selected process

Create inbound process receipt

post

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Adds a receipt to an inbound process.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

inboundProcessIdstringRequired

Body

application/json

InboundReceiptForCreation

asnRefstringOptional

enables mapping a receipt to one of the ASNs in this inbound process

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

receivedDatestring · date-timeRequired

date-time of the arrival of the items in the facility

statusstring · enumOptional

status of this receipt, only receipts with status 'FINISHED' are booked. IN_PROGRESS can be used to save partial receipts.

Possible values:

Responses

201

Receipt was added to the inbound process

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

post

/api/inboundprocesses/{inboundProcessId}/receipts

HTTPcURLJavaScriptPython

POST /api/inboundprocesses/{inboundProcessId}/receipts HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 416

{
  "asnRef": "text",
  "comments": [
    {
      "content": "text",
      "userRef": "text"
    }
  ],
  "customAttributes": {},
  "receivedDate": "2026-03-02T18:02:31.187Z",
  "receivedItems": [
    {
      "acceptedQuantity": {
        "unit": "text",
        "value": 1
      },
      "comments": [
        {
          "content": "text",
          "userRef": "text"
        }
      ],
      "customAttributes": {},
      "rejectedQuantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "storageLocationRef": "text",
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN"
}

{
  "asnRef": "text",
  "comments": [
    {
      "content": "text",
      "documentSetRef": "text",
      "id": "text",
      "userRef": "text"
    }
  ],
  "customAttributes": {},
  "id": "text",
  "receivedDate": "2026-03-02T18:02:31.187Z",
  "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"
}

Update inbound process

patch

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

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

inboundProcessIdstringRequired

Body

application/json

InboundProcessForPatch

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

onHoldbooleanOptional

Indicates if the inbound process is on hold and will not be processed further

scannableCodesstring[]Optional

scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note

versionnumberRequired

Responses

200

Inbound Process successfully patched

No content

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

patch

/api/inboundprocesses/{inboundProcessId}

HTTPcURLJavaScriptPython

PATCH /api/inboundprocesses/{inboundProcessId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "customAttributes": {},
  "onHold": true,
  "scannableCodes": [
    "text"
  ],
  "version": 1
}

No content

Get inbound process

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

inboundProcessIdstringRequired

Responses

200

Requested Inbound Process entity

application/json

InboundProcess

anonymizedbooleanRequired

Indicates the inbound process was anonymized acording to configured GDPR retention time.

createdstring · date-timeRequired

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

facilityRefstringRequired

idstringRequired

inboundDatestring · date-time[]Required

Aggregated dates from sources which advise incoming stock. Currently that is "purchaseOrder"

lastModifiedstring · date-timeRequired

onHoldbooleanRequired

Indicates if the inbound process is on hold and will not be processed further

scannableCodesstring[]Required

scannableCodes such as barcodes that are relevant in the inboundProcess, e.g. , barcode of the delivery note

statusstring · enumRequiredPossible values:

tenantInboundProcessIdstringOptional

versionnumberRequired

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

get

/api/inboundprocesses/{inboundProcessId}

HTTPcURLJavaScriptPython

GET /api/inboundprocesses/{inboundProcessId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "anonymized": true,
  "created": "2026-03-02T18:02:31.187Z",
  "customAttributes": {},
  "facilityRef": "text",
  "id": "text",
  "inboundDate": [
    "2026-03-02T18:02:31.187Z"
  ],
  "lastModified": "2026-03-02T18:02:31.187Z",
  "onHold": true,
  "origin": [
    {
      "name": "text"
    }
  ],
  "purchaseOrder": {
    "created": "2026-03-02T18:02:31.187Z",
    "customAttributes": {},
    "id": "text",
    "lastModified": "2026-03-02T18:02:31.187Z",
    "orderDate": "2026-03-02T18:02:31.187Z",
    "requestedDate": {
      "type": "ASAP",
      "value": "2026-03-02T18:02:31.187Z"
    },
    "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:02:31.187Z",
      "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
}

List inbound processes

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

sizenumber · min: 1 · max: 100OptionalDefault: 25

startAfterIdstringOptional

sortstring · enumOptionalPossible values:

facilityRefstring[]Optional

scannableCodestringOptional

searchTermstringOptional

Matches partial values; The queries terms and therefore the result set of the query can change in the future:

• tenantInboundProcessId
• scannableCodes
• receipts.receivedItems.tenantArticleId
• purchaseOrder.requestedItems.tenantArticleId
• purchaseOrder.supplier.name
• values of related listings
  • listing.title
  • listing.scannableCodes

searchTermExactstringOptional

Only matches complete values; The queries terms and therefore the result set of the query can change in the future:

• tenantInboundProcessId
• scannableCodes
• receipts.receivedItems.tenantArticleId
• purchaseOrder.requestedItems.tenantArticleId
• purchaseOrder.supplier.name
• values of related listings
  • listing.title
  • listing.scannableCodes

purchaseOrder_cancelledbooleanOptional

Responses

200

Paginated result containing the matching Inbound Process entities

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

get

/api/inboundprocesses

HTTPcURLJavaScriptPython

GET /api/inboundprocesses HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "inboundProcesses": [
    {
      "anonymized": true,
      "created": "2026-03-02T18:02:31.187Z",
      "customAttributes": {},
      "facilityRef": "text",
      "id": "text",
      "inboundDate": [
        "2026-03-02T18:02:31.187Z"
      ],
      "lastModified": "2026-03-02T18:02:31.187Z",
      "onHold": true,
      "origin": [
        {
          "name": "text"
        }
      ],
      "purchaseOrder": {
        "created": "2026-03-02T18:02:31.187Z",
        "customAttributes": {},
        "id": "text",
        "lastModified": "2026-03-02T18:02:31.187Z",
        "orderDate": "2026-03-02T18:02:31.187Z",
        "requestedDate": {
          "type": "ASAP",
          "value": "2026-03-02T18:02:31.187Z"
        },
        "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:02:31.187Z",
          "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
}

Delete inbound process

delete

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

inboundProcessIdstringRequired

Responses

200

Inbound Process successfully deleted

No content

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

delete

/api/inboundprocesses/{inboundProcessId}

HTTPcURLJavaScriptPython

DELETE /api/inboundprocesses/{inboundProcessId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Create retry not routable

post

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

204

The retry for all not routable proceses has been succesfully triggered

400

The retry task can not be triggered due to a conflicting operation

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

post

/api/processes/retrynotroutable

HTTPcURLJavaScriptPython

POST /api/processes/retrynotroutable HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update purchase order

put

This part of the API is in Beta status. For details please check the api-release-life-cycle documentation. Creates or updates the specific purchase order of an existing inbound process.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

inboundProcessIdstringRequired

Body

application/json

InboundProcessPurchaseOrderForUpsert

cancelledbooleanOptionalDeprecated

This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

orderDatestring · date-timeRequired

Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.

statusstring · enumOptionalPossible values:

versionnumberRequired

Responses

200

Purchase order successfully updated on inbound process

application/json

InboundProcessPurchaseOrder

cancelledbooleanRequiredDeprecated

This field is deprecated. Set the status to 'CANCELED' Set the purchaseOrder to 'cancelled'. No further deliveries will be expected. Already received goods are unaffected.

createdstring · date-timeRequired

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

idstringRequired

lastModifiedstring · date-timeRequired

orderDatestring · date-timeRequired

Time and date at which the order was placed. Note: This does not refer to the creation date of this entity in the system.

statusstring · enumRequiredPossible values:

201

Purchase order successfully created on inbound process

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

put

/api/inboundprocesses/{inboundProcessId}/purchaseorder

HTTPcURLJavaScriptPython

PUT /api/inboundprocesses/{inboundProcessId}/purchaseorder HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "customAttributes": {},
  "orderDate": "2026-03-02T18:02:31.187Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2026-03-02T18:02:31.187Z"
  },
  "requestedItems": [
    {
      "customAttributes": {},
      "quantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "version": 1
}

{
  "created": "2026-03-02T18:02:31.187Z",
  "customAttributes": {},
  "id": "text",
  "lastModified": "2026-03-02T18:02:31.187Z",
  "orderDate": "2026-03-02T18:02:31.187Z",
  "requestedDate": {
    "type": "ASAP",
    "value": "2026-03-02T18:02:31.187Z"
  },
  "requestedItems": [
    {
      "customAttributes": {},
      "quantity": {
        "unit": "text",
        "value": 1
      },
      "stockProperties": {
        "expiry": "text"
      },
      "tenantArticleId": "text"
    }
  ],
  "status": "OPEN",
  "supplier": {
    "name": "text"
  },
  "transfer": {
    "id": "text"
  }
}

List operative processes

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Get all operative processes

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

facilityIdstringRequired

facility to filter the results

startAfterIdstringOptional

entity to start after

sizeinteger · min: 1 · max: 500Optional

number of entities to show

Default: 25

Responses

200

All operative processes matching the given parameters

application/json

OperativeProcessPaginatedResult

totalnumberRequired

400

Invalid input. See response for details.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

The requested entity was not found

application/json

get

/api/operativeprocesses

HTTPcURLJavaScriptPython

GET /api/operativeprocesses?facilityId=text HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "operativeProcesses": [
    {
      "created": "2026-03-02T18:02:31.187Z",
      "entityChildren": [
        {
          "entityChildren": [
            "[Circular Reference]"
          ],
          "entityRef": "text",
          "entityType": "PICK_JOB"
        }
      ],
      "facilityRef": "text",
      "flatEntityRefs": [
        "text"
      ],
      "id": "text",
      "isEditable": true,
      "lastModified": "2026-03-02T18:02:31.187Z",
      "processRef": "text",
      "routingPlanRef": "text",
      "version": 1
    }
  ],
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "total": 1
}

Get operative process

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Get the operative processes for a specific id

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

operativeProcessIdstringRequired

Responses

200

Found operativeProcess by given ID

application/json

OperativeProcess

createdstring · date-timeOptional

The timestamp when the operative process was created.

facilityRefstringRequired

Reference to the facility this operative process is associated with.

flatEntityRefsstring[]Required

Entities involved in this operative process represented as a flat list of entity references.

idstringRequired

auto generated unique identifier

isEditablebooleanOptional

This field indicates if the operative process is editable based on if any of the related pick jobs, service jobs, pack jobs or handover jobs are in progress or have been finished successfully. This field is calculated dynamically on each request.

lastModifiedstring · date-timeOptional

The timestamp when the operative process was last modified.

processRefstringRequired

Reference to the process this operative process is associated with.

routingPlanRefstringOptional

Reference to the routing plan this operative process is associated with.

versionnumberRequired

The version number of the operative process. This number is incremented each time the operative process is modified.

Example: 1

400

Invalid input. See response for details.

application/json

401

Your user is not allowed to operate against this API instance

application/json

403

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

application/json

404

The requested entity was not found

application/json

get

/api/operativeprocesses/{operativeProcessId}

HTTPcURLJavaScriptPython

GET /api/operativeprocesses/{operativeProcessId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created": "2026-03-02T18:02:31.187Z",
  "entityChildren": [
    {
      "entityChildren": [
        {
          "entityChildren": [
            "[Circular Reference]"
          ],
          "entityRef": "text",
          "entityType": "PICK_JOB"
        }
      ],
      "entityRef": "text",
      "entityType": "PICK_JOB"
    }
  ],
  "facilityRef": "text",
  "flatEntityRefs": [
    "text"
  ],
  "id": "text",
  "isEditable": true,
  "lastModified": "2026-03-02T18:02:31.187Z",
  "processRef": "text",
  "routingPlanRef": "text",
  "version": 1
}