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
    • Address formats for specific carriers
    • Basics
      • Article categories
      • Audits
      • Custom services & bundled line items
      • Facilities
      • Facility groups
      • GDPR configuration
      • Listings
      • Orders
        • Order types
        • Order status
      • Remote configuration
      • Receipts
      • Search
      • Subscribe to events
      • Sticker
      • Stocks
      • Storage locations
      • Tags
      • Users
    • Channel inventory
    • Facility discounts
    • Inbound process
    • Outbound stocks
    • Purchase order
    • Receipt
    • Routing strategy
    • 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
    • Availability & promising
    • Returns
Powered by GitBook
On this page
Edit on GitHub
  1. Integration Guides

Inbound process

Last updated 2 months ago

More inbound process API information can be found here:

Create an inbound process

An inboundProcess maps all processes around incoming goods in a store or warehouse. The inbound process has the sub-entities purchaseOrder and receipt, which can be created and modified as part of the inbound process, or alternatively via their own endpoints. Whenever a purchaseOrder or a receipt is created, a corresponding inboundProcess is automatically created.

Create an inboundProcess by executing the following POST call with the JSON body:

POST https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/inboundprocesses
{
  "facilityRef": "CGN-01",
  "scannableCodes": ["12345"],
  "tenantInboundProcessId": "AB-01"
}

If the request is successful, you receive a 201 CREATED response with a body like this:

{
    "created": "2025-03-12T14:15:39.683Z",
    "facilityRef": "CGN-01",
    "id": "d9f76e9f-6105-4286-b054-1bfbf8eebe77",
    "lastModified": "2025-03-12T14:15:39.683Z",
    "receipts": [],
    "status": "OPEN",
    "version": 1,
    "tenantInboundProcessId": "AB-01",
    "onHold": false,
    "inboundDate": [],
    "origin": [],
    "scannableCodes": [
        "12345"
    ],
    "anonymized": false
}
REST API documentation - Inbound process