fulfillmenttools
API documentationIncident ManagementFeedback
Developer Docs
Developer Docs
  • Developer docs
  • Getting Started
    • Quickstart
    • Integration tutorial
      • Adding facilities
      • Adding listings to facilities
      • Configuring stocks
      • Carrier configuration
      • Placing orders
      • Checkout options
      • Distributed Order Management System (Routing)
      • Local fulfillment configuration
    • Free trial
  • Technical Basics
    • Access to fulfillmenttools
    • Feature status
    • Available regions
    • Backup policies
  • Connecting to fulfillmenttools
    • Client SDKs
    • commercetools connect
    • OpenID connect
      • Configure Microsoft Entra ID / Azure Active Directory
      • Configure Keycloak
  • API
    • Core concepts
      • Authentication & authorization
      • API Versioning & lifecycle
      • Assign user to jobs
      • Localization
      • Resource timestamps
      • Custom attributes
      • Article attributes
      • Recordable attributes
      • Data update guarantees
      • Rate limits & scaling
      • Retries
      • Performance on test vs. production systems
      • Load testing
    • API calls
      • Postman
      • cURL
      • GraphQL Explorer
    • GraphQL API
    • RESTful API
      • Pagination interface
      • RapiDoc
      • OpenAPI 3.0 Spec
    • Eventing
      • Structure of an event
      • Available events
        • Event flows
      • Eventing example
      • Event export
  • Integration Guides
    • Basics
      • Article categories
      • Audits
      • Facilities
      • Facility groups
      • GDPR configuration
      • Listings
      • Remote configuration
      • Receipts
      • Search
      • Subscribe to events
      • Sticker
      • Stocks
      • Storage locations
      • Tags
      • Users
    • Channel inventory
    • Inbound process
    • Outbound stocks
    • Purchase order
    • Receipt
    • Routing strategy (context-based multi-config DOMS)
    • Show sticker to clients
    • Stow jobs
  • More Integration Guides
    • Carrier management
      • Introduction to carrier configuration
      • Required data when operating carriers
      • Adding & connecting carriers to facilities
      • Custom carrier
    • Configurations for order fulfillment
      • Picking configuration
      • Packing configuration
      • Handover configuration
      • Printing and document configuration
      • Packing container types
      • Parcel tag configuration
      • Headless order fulfillment
      • Short-pick reasons
      • External documents in order fulfillment
      • Service jobs
      • Load units
      • Running sequence
    • DOMS - distributed order management system (routing)
    • External actions
    • Interfacility transfer
    • Notifications
    • Orders
      • Place your first order
      • Ship-from-store orders
      • Click-and-collect orders
      • Locked orders
      • Order with custom services
      • Bundled items in an order
      • Order process status
    • Availability & promising
    • Returns
Powered by GitBook
On this page
  • Assign users to job creation
  • Update assigned users
Edit on GitHub
  1. API
  2. Core concepts

Assign user to jobs

Users can be assigned to different fulfillmenttools jobs to mark which user should do which job. With this function, the workload can be distributed in advance among different employees. This user must be available in the system to assign users to a job.

fulfillmenttools does not validate who interacts with jobs. Every user, not only assigned, can interact with it.

The assign user to jobs function is available for pick jobs, pack jobs, handover jobs, and service jobs.

Assign users to job creation

To assign one or more users to a job, they could be added at job creation.

POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/{JOB_ENTITY}

The body of the job must include the assignedUsers array like in the following examples:

Assign one or more users by userId to a job.

{
  // Any job object
  ...
  "assignedUsers": [
    {
      "userId": "{USER_ID}"
    }
  ]
}

Assign one or more users by userName to a job.

{
  // Any job object
  ...
  "assignedUsers": [
    {
      "userName": "{USER_NAME}"
    }
  ]
}

Update assigned users

An action is available to update a job's users. All users in this action, that are sent to the backend, will be replaced in the job.

POST https://{YOUR_TENANT_NAME}.api.fulfillmenttools.com/api/{JOB_ENTITY}/actions

The body of the action must look like in the following examples:

Update one or more users by userId of a job.

{
  "name": "REPLACE_ASSIGNED_USERS",
  "assignedUsers": [
    {
      "userId": "{USER_ID}"
    }
  ],
  "version": 2
}

Update one or more users by userName of a job.

{
  "name": "REPLACE_ASSIGNED_USERS",
  "assignedUsers": [
    {
      "userName": "{USER_NAME}"
    }
  ],
  "version": 2
}

Last updated 2 months ago