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
    • 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
    • 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
  • Placeholders
  • Place the order
  • Restrictions
Edit on GitHub
  1. More Integration Guides
  2. Orders

Place your first order

Last updated 5 months ago

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.

REST API documentation for adding orders