fulfillmenttools
  • Welcome to the fulfillmenttools Platform Documentation
  • Getting Started
    • Setup your access to fulfillmenttools
    • Make your first API Calls
      • Add your first facility
      • Add your first listing
      • Place your first order
    • Core concepts & terminology
      • Order Flow
    • Postman Collection
    • Client SDKs
    • FAQ
  • Clients
    • Backoffice
      • First steps - Registration
      • Network view
        • Home
        • Orders
          • Unroutable orders
          • Pre-orders & Backorders
          • Order History
        • Inventory Management
          • Stock Overview
          • Channel Inventory
        • Facilities
        • Users
        • Returns
        • DOMS configuration
        • Settings
        • Analytics
          • DOMS Pages
          • Fulfillment Operations Pages
          • Inventory Pages
          • Downloads Page
      • Facility view
        • Home
        • Inbound
        • Tasks
        • Listings
        • Storage Locations
        • Facility
        • Users
    • Inventory app
      • Registration Inventory App
      • App sections
        • Inbound
        • Storage and relocation
    • Operations app
      • Android
        • Manual Registration
        • Android Enterprise Registration
        • Sections
          • Picking
            • Load Units (legacy)
            • Substitute items
            • Weighed or measured products
            • Scanning configuration
            • Picking Methods
              • Batch Picking
              • Multi Order Picking
          • Packing
          • Handover
          • Returns (legacy)
        • Printing
        • Notifications
      • Webapp
        • Packing
      • Overview features Android & Webapp
    • Technical requirements
      • Zebra Hardware Scanner Configuration
      • Honeywell Hardware Scanner Configuration
      • Supported barcodes for camera scanning
      • Requirements for fft applications
      • Zebra printer
    • Returns app
      • Handle unannounced returns
      • Handle announced returns
  • Products
    • Core Functionality
      • Process
        • External actions
      • Add and manage facilities
      • Notification Center
      • Checking on features
      • Tags and Stickers Concept
      • GDPR
      • Remote Configuration
      • Expiry
      • Target time
      • Time calculation for queries of future availabilities (LPS-calculation)
      • Interfacility Transfer
    • Carrier Management
      • Overview
        • Available Carriers
      • Concepts
        • Carrier Country Service Mapping (CCSM)
        • Non-delivery-days
        • Custom Carrier & Headless operation of Carriers
      • Providing needed data
    • Fulfillment Options
      • Fulfillability Check
      • Checkout Options
        • Available fulfillment options based on basket
        • Earliest possible delivery date
        • Available delivery dates within time-period
        • Availability for delivery date
      • Delivery Promise
    • Inventory Management
      • Configurations
      • Entities
        • Listing
        • Stock
          • Stock Properties
        • Storage Location
        • Zone
      • Global Inventory
        • Stock availability
        • Channel Inventory
        • Expected stock
        • Inbound Process
        • Reservations
        • Safety Stock
      • Inventory Control
        • Inventory Traits
        • Measurement Units
        • Outbound Inventory Tracking
        • Storage Location Recommendations
    • Order Fulfillment
      • Headless Order Fulfillment
      • Pick Jobs
      • Zone picking
      • Load Units
      • Custom Service
      • Handover Jobs
      • Add External Documents
      • Configurations
        • Picking Configuration
          • Picking methods
          • Short Pick Reasons
        • Packing Configuration
          • Packing Container Types
        • Print / Document Configuration
        • Tag Configurations
          • Parcel Tag Configuration
        • Handover Configuration
        • Operative Container Types
    • Order Routing
      • Entities
        • Ship-from-Store Orders
        • Click-and-Collect Orders
        • Locked Orders
        • Custom Services Orders
          • Simple Custom Service Order
          • Complex Custom Service Order
      • Fences
      • Ratings
      • Order Split
        • Order split - initial routing
        • Order split after shortpick
        • Item bundles
      • Reroute
      • Shape the routing with the DOMS Toolkit
      • Decision logs
    • Returns Management
      • Returns legacy
        • Available status
      • Returns 2.0
        • Return Reasons
        • Item Conditions
        • Integrating Returns with Events
    • Use Cases
      • Demand-Driven Replenishment
      • Expected stock in availability
      • Multi Order Picking
      • Interfacility transfer
      • Assigned Users
  • Connecting to fulfillmenttools
    • General Topics
      • Use external identity providers to authenticate to fulfillmenttools
        • Microsoft Entra ID / Azure Active Directory (AD)
      • Public Event Export
      • Available Regions
      • Backup Policies
    • GraphQL API
    • RESTful API
      • General Topics
        • API Release Life Cycle
        • Versioning
        • Authorization
        • Customization via Attributes
        • Update Guarantees
        • Rate Limits
        • Resource Timestamps
        • Pagination Interface
        • Localization
        • Custom Attributes
      • OpenAPI Specification
        • Swagger UI
        • OpenAPI 3.0 Spec
    • Eventing
      • Structure of an Event
      • Available Events
      • Tutorial
    • commercetools Connect
    • Integration Tutorial
      • Adding facilities
      • Adding listings to facilities
      • Configuring stocks
      • Carrier configuration
      • Placing orders
      • Checkout Options
      • Distributed Order Management System (Routing)
      • Local fulfillment configuration
  • Incident Reporting
    • How to report incidents in fulfillmenttools
    • How to define incident priorities
  • Release Notes
    • Release Summary – May 2024
    • Release Summary – June 2024
    • Release Summary – July 2024
    • Release Summary – August 2024
    • Release Summary – September 2024
    • Release Summary – October 2024
Powered by GitBook
On this page
  • Placeholders
  • Place the order
  • Restrictions

Was this helpful?

  1. Getting Started
  2. Make your first API Calls

Place your first order

Learn how to place your first order via API.

PreviousAdd your first listingNextCore concepts & terminology

Last updated 5 months ago

Was this helpful?

This page is outdated. Please go to our new documentation under .

After you successfully added a listing and your first facility, it is time to learn how to place an order which you the pickers in the facility can fulfill.

Placeholders

Placeholder
Replace with
Example

{TOKEN}

JWT from Identity provider

eyJhbGciOX49.eyJzdWV9.dyt0CoI

Place the order

To place an order, we need some information coming from your system. For more details which information we need and which can be added, see our .

Lets make the API call:

curl -sSL -X POST 'https://your.api.fulfillmenttools.com/api/orders' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "consumer": {
    "addresses": [
      {
        "city": "München",
        "country": "DE",
        "houseNumber": "1",
        "postalCode": "80802",
        "street": "Biedersteiner Str.",
        "firstName": "Charlie",
        "lastName": "Bucket",
        "salutation": "Herr"
      }
    ],
    "email": "charlie.bucket@example.com"
  },
  "orderDate": "2020-08-22T08:45:50.525Z",
  "orderLineItems": [
    {
      "article": {
        "tenantArticleId": "4892",
        "title": "Wonkas Chocolate Bar"
      },
      "quantity": 1
    }
  ],
  "status": "OPEN",
  "tenantOrderId": "R456728546"
}'

If the request was successful, you'll receive a 201 CREATED response containing the order item. Very important is the orderId property as this is needed for further requests on that order.

{
    "consumer": {
        "addresses": [
            {
                "city": "München",
                "country": "DE",
                "houseNumber": "1",
                "postalCode": "80802",
                "street": "Biedersteiner Str.",
                "firstName": "Charlie",
                "lastName": "Bucket",
                "salutation": "Herr"
            }
        ],
        "email": "charlie.bucket@example.com"
    },
    "orderDate": "2020-08-22T08:45:50.525Z",
    "orderLineItems": [
        {
            "article": {
                "tenantArticleId": "4892",
                "title": "Wonkas Chocolate Bar"
            },
            "quantity": 1,
            "id": "ae204050-009e-48a1-9438-0d809df151dc"
        }
    ],
    "status": "OPEN",
    "tenantOrderId": "R456728546",
    "deliveryPreferences": {
        "shipping": {
            "serviceLevel": "DELIVERY"
        }
    },
    "id": "1f979dc1-1a69-45e0-bb25-f8f57e6ede6f",
    "tags": [],
    "processId": "c31bdf12-6f90-4e27-ba26-ad7351e8a897",
    "created": "2023-08-22T13:28:13.178Z",
    "lastModified": "2023-08-22T13:28:13.178Z",
    "schemaVersion": 1,
    "version": 1
}

Restrictions

It is only possible to place an order with a duplicated tenantOrderId if the previous orders are not in the status OPEN, LOCKED, or PROMISED. Otherwise, your order creation request will be denied.

If you want to reuse a tenantOrderId and the previous order is in the status OPEN, LOCKED, or PROMISED, you must cancel the previous order first.

https://docs.fulfillmenttools.com/documentation
REST API documentation for adding orders